Java 17 Upgrade

[policy/models.git] / models-base / src / main / java / org / onap / policy / models / base / PfKeyUse.java

diff --git a/models-base/src/main/java/org/onap/policy/models/base/PfKeyUse.java b/models-base/src/main/java/org/onap/policy/models/base/PfKeyUse.java
index 0eb55a7..f9141cc 100644 (file)
--- a/models-base/src/main/java/org/onap/policy/models/base/PfKeyUse.java
+++ b/models-base/src/main/java/org/onap/policy/models/base/PfKeyUse.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2019, 2023 Nordix Foundation.
+ *  Modifications Copyright (C) 2019-2020 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.
@@ -20,26 +21,33 @@
 
 package org.onap.policy.models.base;
 
+import java.io.Serial;
 import java.util.List;
-
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NonNull;
 import lombok.ToString;
-
+import org.onap.policy.common.parameters.annotations.NotNull;
 import org.onap.policy.common.utils.validation.Assertions;
-import org.onap.policy.models.base.PfValidationResult.ValidationResult;
+import org.onap.policy.models.base.validation.annotations.VerifyKey;
 
 /**
- * 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 PfConcept} 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 PfKeyUse} objects.
+ * 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 PfConcept} 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 PfKeyUse} objects.
  *
  * <p>Validation checks that each key is valid.
  */
 @EqualsAndHashCode(callSuper = false)
 @ToString
 public class PfKeyUse extends PfKey {
+    @Serial
     private static final long serialVersionUID = 2007147220109881705L;
 
+    @VerifyKey
+    @NotNull
+    @Getter
     private PfKey usedKey;
 
     /**
@@ -50,22 +58,22 @@ public class PfKeyUse extends PfKey {
     }
 
     /**
-     * Copy constructor.
+     * This constructor creates an instance of this class, and holds a reference to a used key.
      *
-     * @param copyConcept the concept to copy from
+     * @param usedKey a used key
      */
-    public PfKeyUse(final PfKeyUse copyConcept) {
-        super(copyConcept);
+    public PfKeyUse(@NonNull final PfKey usedKey) {
+        this.usedKey = usedKey;
     }
 
     /**
-     * This constructor creates an instance of this class, and holds a reference to a used key.
+     * Copy constructor.
      *
-     * @param usedKey a used key
+     * @param copyConcept the concept to copy from
      */
-    public PfKeyUse(final PfKey usedKey) {
-        Assertions.argumentNotNull(usedKey, "usedKey may not be null");
-        this.usedKey = usedKey;
+    public PfKeyUse(@NonNull final PfKeyUse copyConcept) {
+        super(copyConcept);
+        this.usedKey = PfUtils.makeCopy(copyConcept.usedKey);
     }
 
     @Override
@@ -83,67 +91,64 @@ public class PfKeyUse extends PfKey {
         return usedKey.getId();
     }
 
+    @Override
+    public boolean isNullKey() {
+        return usedKey.isNullKey();
+    }
+
     /**
      * Sets the key.
      *
      * @param key the key
      */
-    public void setKey(final PfKey key) {
-        Assertions.argumentNotNull(key, "usedKey may not be null");
+    public void setKey(@NonNull final PfKey key) {
         this.usedKey = key;
     }
 
     @Override
-    public PfKey.Compatibility getCompatibility(final PfKey otherKey) {
+    public PfKey.Compatibility getCompatibility(@NonNull final PfKey otherKey) {
         return usedKey.getCompatibility(otherKey);
     }
 
     @Override
-    public boolean isCompatible(final PfKey otherKey) {
+    public boolean isCompatible(@NonNull final PfKey otherKey) {
         return usedKey.isCompatible(otherKey);
     }
 
     @Override
-    public PfValidationResult validate(final PfValidationResult result) {
-        if (usedKey.equals(PfConceptKey.getNullKey())) {
-            result.addValidationMessage(new PfValidationMessage(usedKey, this.getClass(), ValidationResult.INVALID,
-                    "usedKey is a null key"));
-        }
-        return usedKey.validate(result);
+    public boolean isNewerThan(@NonNull final PfKey otherKey) {
+        return usedKey.isCompatible(otherKey);
     }
 
     @Override
-    public void clean() {
-        usedKey.clean();
+    public int getMajorVersion() {
+        return usedKey.getMajorVersion();
     }
 
     @Override
-    public PfConcept copyTo(final PfConcept target) {
-        Assertions.argumentNotNull(target, "target may not be null");
-
-        final Object copyObject = target;
-        Assertions.instanceOf(copyObject, PfKeyUse.class);
+    public int getMinorVersion() {
+        return usedKey.getMinorVersion();
+    }
 
-        final PfKeyUse copy = ((PfKeyUse) copyObject);
-        try {
-            copy.usedKey = usedKey.getClass().newInstance();
-        } catch (final Exception e) {
-            throw new PfModelRuntimeException("error copying concept key: " + e.getMessage(), e);
-        }
-        usedKey.copyTo(copy.usedKey);
+    @Override
+    public int getPatchVersion() {
+        return usedKey.getPatchVersion();
+    }
 
-        return copy;
+    @Override
+    public void clean() {
+        usedKey.clean();
     }
 
     @Override
-    public int compareTo(final PfConcept otherObj) {
+    public int compareTo(@NonNull final PfConcept otherObj) {
         Assertions.argumentNotNull(otherObj, "comparison object may not be null");
 
         if (this == otherObj) {
             return 0;
         }
         if (getClass() != otherObj.getClass()) {
-            return this.hashCode() - otherObj.hashCode();
+            return getClass().getName().compareTo(otherObj.getClass().getName());
         }
 
         final PfKeyUse other = (PfKeyUse) otherObj;