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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. 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.apex.model.basicmodel.concepts;
import java.util.List;
import org.onap.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.utilities.Assertions;
/**
* This class records a usage of a key in the system. When the list of keys being used by a concept is built using the getKeys() method of
* the {@link AxConcept} class, an instance of this class is created for every key occurrence. The list of keys returned by the getKeys()
* method is a list of {@link AxKeyUse} objects.
* <p>
* Validation checks that each key is valid.
*/
public class AxKeyUse extends AxKey {
private static final long serialVersionUID = 2007147220109881705L;
private AxKey usedKey;
/**
* The Default Constructor creates this concept with a null key.
*/
public AxKeyUse() {
this(new AxArtifactKey());
}
/**
* Copy constructor
* @param copyConcept the concept to copy from
*/
public AxKeyUse(final AxKeyUse copyConcept) {
super(copyConcept);
}
/**
* This constructor creates an instance of this class, and holds a reference to a used key.
*
* @param usedKey a used key
*/
public AxKeyUse(final AxKey usedKey) {
Assertions.argumentNotNull(usedKey, "usedKey may not be null");
this.usedKey = usedKey;
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#getKey()
*/
@Override
public AxKey getKey() {
return usedKey;
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#getKeys()
*/
@Override
public List<AxKey> getKeys() {
return usedKey.getKeys();
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxKey#getID()
*/
@Override
public String getID() {
return usedKey.getID();
}
/**
* Sets the key.
*
* @param key the key
*/
public void setKey(final AxKey key) {
Assertions.argumentNotNull(key, "usedKey may not be null");
this.usedKey = key;
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxKey#getCompatibility(com. ericsson.apex.model.basicmodel.concepts.AxKey)
*/
@Override
public AxKey.Compatibility getCompatibility(final AxKey otherKey) {
return usedKey.getCompatibility(otherKey);
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxKey#isCompatible(com. ericsson.apex.model.basicmodel.concepts.AxKey)
*/
@Override
public boolean isCompatible(final AxKey otherKey) {
return usedKey.isCompatible(otherKey);
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#validate(com. ericsson.apex.model.basicmodel.concepts.AxValidationResult)
*/
@Override
public AxValidationResult validate(final AxValidationResult result) {
if (usedKey.equals(AxArtifactKey.getNullKey())) {
result.addValidationMessage(
new AxValidationMessage(usedKey, this.getClass(), ValidationResult.INVALID, "usedKey is a null key"));
}
return usedKey.validate(result);
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#clean()
*/
@Override
public void clean() {
usedKey.clean();
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#toString()
*/
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append(this.getClass().getSimpleName());
builder.append(":(");
builder.append("usedKey=");
builder.append(usedKey);
builder.append(")");
return builder.toString();
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#copyTo(com.ericsson.apex.model.basicmodel.concepts.AxConcept)
*/
@Override
public AxConcept copyTo(final AxConcept target) {
Assertions.argumentNotNull(target, "target may not be null");
final Object copyObject = target;
Assertions.instanceOf(copyObject, AxKeyUse.class);
final AxKeyUse copy = ((AxKeyUse) copyObject);
try {
copy.usedKey = usedKey.getClass().newInstance();
}
catch (Exception e) {
throw new ApexRuntimeException("error copying concept key: " + e.getMessage(), e);
}
usedKey.copyTo(copy.usedKey);
return copy;
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#hashCode()
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + usedKey.hashCode();
return result;
}
/*
* (non-Javadoc)
*
* @see com.ericsson.apex.model.basicmodel.concepts.AxConcept#equals(java.lang. Object)
*/
@Override
public boolean equals(final Object obj) {
if (obj == null) {
throw new IllegalArgumentException("comparison object may not be null");
}
if (this == obj) {
return true;
}
if (getClass() != obj.getClass()) {
return false;
}
final AxKeyUse other = (AxKeyUse) obj;
return usedKey.equals(other.usedKey);
}
/*
* (non-Javadoc)
*
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
public int compareTo(final AxConcept otherObj) {
Assertions.argumentNotNull(otherObj, "comparison object may not be null");
if (this == otherObj) {
return 0;
}
if (getClass() != otherObj.getClass()) {
return this.hashCode() - otherObj.hashCode();
}
final AxKeyUse other = (AxKeyUse) otherObj;
return usedKey.compareTo(other.usedKey);
}
}
|
