blob: 2357ec00da98e14364fa460c4412d9adaba06f1d (
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019 Nordix Foundation.
* Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.models.base;
import java.io.Serializable;
import java.util.List;
import lombok.NonNull;
/**
* This class is the base class for all Policy Framework concept classes. It enforces implementation of abstract methods
* and interfaces on all concepts that are sub-classes of this class.
*/
public abstract class PfConcept extends Validated implements Serializable, Comparable<PfConcept> {
private static final long serialVersionUID = -7434939557282697490L;
/**
* Default constructor.
*/
protected PfConcept() {
// Default Constructor
}
/**
* Copy constructor.
*
* @param copyConcept the concept to copy from
*/
protected PfConcept(@NonNull final PfConcept copyConcept) {
// nothing else to do (other than @NonNull check)
}
/**
* Gets the key of this concept.
*
* @return the concept key
*/
public abstract PfKey getKey();
/**
* Gets a list of all keys for this concept and all concepts that are defined or referenced by this concept and its
* sub-concepts.
*
* @return the keys used by this concept and its contained concepts
*/
public abstract List<PfKey> getKeys();
/**
* Clean this concept, tidy up any superfluous information such as leading and trailing white space.
*/
public abstract void clean();
@Override
public abstract boolean equals(Object otherObject);
@Override
public abstract String toString();
@Override
public abstract int hashCode();
/**
* Gets the ID string of this concept.
*
* @return the ID string of this concept
*/
public String getId() {
return getKey().getId();
}
/**
* Gets the name of this concept.
*
* @return the name of this concept
*/
public String getName() {
return getKey().getName();
}
/**
* Gets the version of this concept.
*
* @return the version of this concept
*/
public String getVersion() {
return getKey().getVersion();
}
/**
* Checks if this key matches the given key ID.
*
* @param id the key ID to match against
* @return true, if this key matches the ID
*/
public final boolean matchesId(@NonNull final String id) {
// Check the ID
return getId().equals(id);
}
}
|
