blob: f992d727a40b5deb55eac1b184d511976504529b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.net.config;
import com.google.common.annotations.Beta;
/**
* Base abstract factory for creating configuration subjects from their
* string key image.
*
* @param <S> subject class
*/
@Beta
public abstract class SubjectFactory<S> {
private final Class<S> subjectClass;
private final String subjectClassKey;
/**
* Creates a new configuration factory for the specified class of subjects
* capable of generating the configurations of the specified class. The
* subject and configuration class keys are used merely as keys for use in
* composite JSON trees.
*
* @param subjectClass subject class
* @param subjectClassKey subject class key
*/
protected SubjectFactory(Class<S> subjectClass, String subjectClassKey) {
this.subjectClass = subjectClass;
this.subjectClassKey = subjectClassKey;
}
/**
* Returns the class of the subject to which this factory applies.
*
* @return subject type
*/
public Class<S> subjectClass() {
return subjectClass;
}
/**
* Returns the unique key of this configuration subject class.
* This is primarily aimed for use in composite JSON trees in external
* representations and has no bearing on the internal behaviours.
*
* @return configuration key
*/
public String subjectClassKey() {
return subjectClassKey;
}
/**
* Returns the unique key of the specified configuration subject.
* This is primarily aimed for use in composite JSON trees in external
* representations and has no bearing on the internal behaviours.
*
* @param subject specific subject
* @return subject key
*/
public String subjectKey(S subject) {
return subject.toString();
}
/**
* Creates a configuration subject from its key image.
*
* @param subjectKey subject class key
* @return configuration subject
*/
public abstract S createSubject(String subjectKey);
}
|
