2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.base;
24 import java.util.List;
25 import lombok.EqualsAndHashCode;
26 import lombok.NonNull;
27 import lombok.ToString;
28 import org.onap.policy.common.utils.validation.Assertions;
29 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
32 * This class records a usage of a key in the system. When the list of keys being used by a concept
33 * is built using the getKeys() method of the {@link PfConcept} class, an instance of this class is
34 * created for every key occurrence. The list of keys returned by the getKeys() method is a list of
35 * {@link PfKeyUse} objects.
37 * <p>Validation checks that each key is valid.
39 @EqualsAndHashCode(callSuper = false)
41 public class PfKeyUse extends PfKey {
42 private static final long serialVersionUID = 2007147220109881705L;
44 private PfKey usedKey;
47 * The Default Constructor creates this concept with a null key.
50 this(new PfConceptKey());
54 * This constructor creates an instance of this class, and holds a reference to a used key.
56 * @param usedKey a used key
58 public PfKeyUse(@NonNull final PfKey usedKey) {
59 this.usedKey = usedKey;
65 * @param copyConcept the concept to copy from
67 public PfKeyUse(@NonNull final PfKeyUse copyConcept) {
69 this.usedKey = PfUtils.makeCopy(copyConcept.usedKey);
73 public PfKey getKey() {
78 public List<PfKey> getKeys() {
79 return usedKey.getKeys();
83 public String getId() {
84 return usedKey.getId();
88 public boolean isNullKey() {
89 return usedKey.isNullKey();
97 public void setKey(@NonNull final PfKey key) {
102 public PfKey.Compatibility getCompatibility(@NonNull final PfKey otherKey) {
103 return usedKey.getCompatibility(otherKey);
107 public boolean isCompatible(@NonNull final PfKey otherKey) {
108 return usedKey.isCompatible(otherKey);
112 public boolean isNewerThan(@NonNull final PfKey otherKey) {
113 return usedKey.isCompatible(otherKey);
117 public int getMajorVersion() {
118 return usedKey.getMajorVersion();
122 public int getMinorVersion() {
123 return usedKey.getMinorVersion();
127 public int getPatchVersion() {
128 return usedKey.getPatchVersion();
132 public void clean() {
137 public PfValidationResult validate(@NonNull final PfValidationResult result) {
138 if (usedKey.isNullKey()) {
139 result.addValidationMessage(new PfValidationMessage(usedKey, this.getClass(), ValidationResult.INVALID,
140 "usedKey is a null key"));
142 return usedKey.validate(result);
146 public int compareTo(final PfConcept otherObj) {
147 Assertions.argumentNotNull(otherObj, "comparison object may not be null");
149 if (this == otherObj) {
152 if (getClass() != otherObj.getClass()) {
153 return getClass().getName().compareTo(otherObj.getClass().getName());
156 final PfKeyUse other = (PfKeyUse) otherObj;
158 return usedKey.compareTo(other.usedKey);