Java 17 Upgrade
[policy/models.git] / models-base / src / main / java / org / onap / policy / models / base / PfConceptContainer.java
index e7cab46..395a42c 100644 (file)
@@ -1,7 +1,8 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019-2020 Nordix Foundation.
+ *  Copyright (C) 2019-2020, 2023 Nordix Foundation.
  *  Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
+ *  Modifications Copyright (C) 2022 Bell Canada. 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.
 package org.onap.policy.models.base;
 
 import com.google.re2j.Pattern;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.EmbeddedId;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.JoinTable;
+import jakarta.persistence.ManyToMany;
+import jakarta.persistence.MappedSuperclass;
+import jakarta.persistence.Table;
+import jakarta.ws.rs.core.Response;
+import java.io.Serial;
 import java.lang.reflect.ParameterizedType;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
@@ -33,14 +43,6 @@ import java.util.Set;
 import java.util.TreeMap;
 import java.util.TreeSet;
 import java.util.function.Function;
-import javax.persistence.CascadeType;
-import javax.persistence.EmbeddedId;
-import javax.persistence.JoinColumn;
-import javax.persistence.JoinTable;
-import javax.persistence.ManyToMany;
-import javax.persistence.MappedSuperclass;
-import javax.persistence.Table;
-import javax.ws.rs.core.Response;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NonNull;
@@ -60,7 +62,7 @@ import org.onap.policy.models.base.validation.annotations.VerifyKey;
  * Each concept entry is checked to ensure that its key and value are not null and that the key matches the key in the
  * map value. Each concept entry is then validated individually.
  *
- * @param C the concept being contained
+ * @param <C> the concept being contained
  */
 //@formatter:on
 @MappedSuperclass
@@ -69,7 +71,8 @@ import org.onap.policy.models.base.validation.annotations.VerifyKey;
 @EqualsAndHashCode(callSuper = false)
 
 public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> extends PfConcept
-        implements PfConceptGetter<C>, PfAuthorative<List<Map<String, A>>> {
+    implements PfConceptGetter<C>, PfAuthorative<List<Map<String, A>>> {
+    @Serial
     private static final long serialVersionUID = -324211738823208318L;
 
     private static final String VALUE_FIELD = "value";
@@ -114,9 +117,9 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
     }
 
     /**
-     * This Constructor creates an concept container with all of its fields defined.
+     * This Constructor creates a concept container with all of its fields defined.
      *
-     * @param key the concept container key
+     * @param key        the concept container key
      * @param conceptMap the concepts to be stored in the concept container
      */
     public PfConceptContainer(@NonNull final PfConceptKey key, @NonNull final Map<PfConceptKey, C> conceptMap) {
@@ -137,8 +140,8 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
 
         this.conceptMap = new TreeMap<>();
         for (final Entry<PfConceptKey, C> conceptMapEntry : copyConcept.conceptMap.entrySet()) {
-            PfConceptKey newK = new PfConceptKey(conceptMapEntry.getKey());
-            C newC = PfUtils.makeCopy(conceptMapEntry.getValue());
+            var newK = new PfConceptKey(conceptMapEntry.getKey());
+            var newC = PfUtils.makeCopy(conceptMapEntry.getValue());
             this.conceptMap.put(newK, newC);
         }
     }
@@ -186,7 +189,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
             // Add the map entries one by one
             for (Entry<String, A> incomingConceptEntry : incomingConceptMap.entrySet()) {
 
-                PfConceptKey conceptKey = new PfConceptKey();
+                var conceptKey = new PfConceptKey();
                 if (KEY_ID_PATTERN.matches(incomingConceptEntry.getKey())) {
                     conceptKey = new PfConceptKey(incomingConceptEntry.getKey());
                 } else {
@@ -199,11 +202,11 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
                 }
 
                 incomingConceptEntry.getValue().setName(findConceptField(conceptKey, conceptKey.getName(),
-                        incomingConceptEntry.getValue(), PfNameVersion::getDefinedName));
+                    incomingConceptEntry.getValue(), PfNameVersion::getDefinedName));
                 incomingConceptEntry.getValue().setVersion(findConceptField(conceptKey, conceptKey.getVersion(),
-                        incomingConceptEntry.getValue(), PfNameVersion::getDefinedVersion));
+                    incomingConceptEntry.getValue(), PfNameVersion::getDefinedVersion));
 
-                C jpaConcept = getConceptNewInstance();
+                var jpaConcept = getConceptNewInstance();
                 // This cast allows us to call the fromAuthorative method
                 @SuppressWarnings("unchecked")
                 PfAuthorative<A> authoritiveImpl = (PfAuthorative<A>) jpaConcept;
@@ -218,7 +221,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
 
         if (conceptMap.isEmpty()) {
             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST,
-                    "An incoming list of concepts must have at least one entry");
+                "An incoming list of concepts must have at least one entry");
         }
     }
 
@@ -260,7 +263,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
      * @return the validation result
      */
     private ValidationResult validateConceptMap() {
-        BeanValidationResult result = new BeanValidationResult("conceptMap", conceptMap);
+        var result = new BeanValidationResult("conceptMap", conceptMap);
 
         for (final Entry<PfConceptKey, C> conceptEntry : conceptMap.entrySet()) {
             BeanValidationResult result2 = null;
@@ -285,10 +288,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
     }
 
     @Override
-    public int compareTo(final PfConcept otherConcept) {
-        if (otherConcept == null) {
-            return -1;
-        }
+    public int compareTo(@NonNull final PfConcept otherConcept) {
         if (this == otherConcept) {
             return 0;
         }
@@ -296,8 +296,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
             return getClass().getName().compareTo(otherConcept.getClass().getName());
         }
 
-        @SuppressWarnings("unchecked")
-        final PfConceptContainer<C, A> other = (PfConceptContainer<C, A>) otherConcept;
+        @SuppressWarnings("unchecked") final PfConceptContainer<C, A> other = (PfConceptContainer<C, A>) otherConcept;
         int retVal = key.compareTo(other.key);
         if (retVal != 0) {
             return retVal;
@@ -309,7 +308,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
     /**
      * Get all the concepts that match the given name and version.
      *
-     * @param conceptKeyName the name of the concept, if null, return all names
+     * @param conceptKeyName    the name of the concept, if null, return all names
      * @param conceptKeyVersion the version of the concept, if null, return all versions
      * @return conceptKeyVersion
      */
@@ -318,7 +317,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
             return getAll(conceptKeyName, conceptKeyVersion);
         } else {
             final Set<C> returnSet = new TreeSet<>();
-            C foundConcept = get(conceptKeyName, conceptKeyVersion);
+            var foundConcept = get(conceptKeyName, conceptKeyVersion);
             if (foundConcept != null) {
                 returnSet.add(foundConcept);
             }
@@ -331,30 +330,37 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
         if (conceptKey.isNullVersion()) {
             return get(conceptKey.getName());
         } else {
-            return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKey);
+            return new PfConceptGetterImpl<>(getNavigableConceptMap()).get(conceptKey);
         }
     }
 
     @Override
     public C get(final String conceptKeyName) {
-        return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName);
+        return new PfConceptGetterImpl<>(getNavigableConceptMap()).get(conceptKeyName);
     }
 
     @Override
     public C get(final String conceptKeyName, final String conceptKeyVersion) {
-        return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).get(conceptKeyName,
-                conceptKeyVersion);
+        return new PfConceptGetterImpl<>(getNavigableConceptMap()).get(conceptKeyName, conceptKeyVersion);
     }
 
     @Override
     public Set<C> getAll(final String conceptKeyName) {
-        return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName);
+        return new PfConceptGetterImpl<>(getNavigableConceptMap()).getAll(conceptKeyName);
     }
 
     @Override
     public Set<C> getAll(final String conceptKeyName, final String conceptKeyVersion) {
-        return new PfConceptGetterImpl<>((NavigableMap<PfConceptKey, C>) conceptMap).getAll(conceptKeyName,
-                conceptKeyVersion);
+        return new PfConceptGetterImpl<>(getNavigableConceptMap()).getAll(conceptKeyName, conceptKeyVersion);
+    }
+
+    /**
+     * Get the concept map as a NavigableMap object.
+     *
+     * @return NavigableMap conceptMap instance.
+     */
+    private NavigableMap<PfConceptKey, C> getNavigableConceptMap() {
+        return new TreeMap<>(conceptMap);
     }
 
     /**
@@ -366,16 +372,17 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
     private C getConceptNewInstance() {
         try {
             String conceptClassName =
-                    ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName();
+                ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0].getTypeName();
             return (C) Class.forName(conceptClassName).getDeclaredConstructor().newInstance();
         } catch (Exception ex) {
             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR,
-                    "failed to instantiate instance of container concept class", ex);
+                "failed to instantiate instance of container concept class", ex);
         }
     }
 
     private String findConceptField(final PfConceptKey conceptKey, final String keyFieldValue,
-            final PfNameVersion concept, final Function<PfNameVersion, String> fieldGetterFunction) {
+                                    final PfNameVersion concept,
+                                    final Function<PfNameVersion, String> fieldGetterFunction) {
 
         String conceptField = fieldGetterFunction.apply(concept);
 
@@ -383,7 +390,7 @@ public class PfConceptContainer<C extends PfConcept, A extends PfNameVersion> ex
             return keyFieldValue;
         } else {
             throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, "Key " + conceptKey.getId() + " field "
-                    + keyFieldValue + " does not match the value " + conceptField + " in the concept field");
+                + keyFieldValue + " does not match the value " + conceptField + " in the concept field");
         }
     }
-}
+}
\ No newline at end of file