Changes for Checkstyle 8.32

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

diff --git a/models-base/src/main/java/org/onap/policy/models/base/PfConcept.java b/models-base/src/main/java/org/onap/policy/models/base/PfConcept.java
index 99eee8d..5273bd3 100644 (file)
--- a/models-base/src/main/java/org/onap/policy/models/base/PfConcept.java
+++ b/models-base/src/main/java/org/onap/policy/models/base/PfConcept.java
@@ -1,6 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2019 Nordix Foundation.
+ *  Modifications Copyright (C) 2019 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.
@@ -22,34 +23,30 @@ package org.onap.policy.models.base;
 
 import java.io.Serializable;
 import java.util.List;
-
-import javax.xml.bind.annotation.XmlType;
-
-import org.onap.policy.common.utils.validation.Assertions;
+import lombok.NonNull;
 
 /**
- * This class is the base class for all model concept classes. It enforces implementation of
- * abstract methods and interfaces on all concepts that are sub-classes of this class.
+ * 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.
  */
 
-@XmlType(name = "PfConcept", namespace = "http://www.onap.org/policy/models")
-
 public abstract class PfConcept implements Serializable, Comparable<PfConcept> {
     private static final long serialVersionUID = -7434939557282697490L;
 
     /**
      * Default constructor.
      */
-    public PfConcept() {}
+    public PfConcept() {
+        // Default Constructor
+    }
 
     /**
      * Copy constructor.
      *
      * @param copyConcept the concept to copy from
      */
-    public PfConcept(final PfConcept copyConcept) {
-        Assertions.argumentNotNull(copyConcept, "copy concept may not be null");
-        copyConcept.copyTo(this);
+    public PfConcept(@NonNull final PfConcept copyConcept) {
+        // nothing else to do (other than @NonNull check)
     }
 
     /**
@@ -60,10 +57,10 @@ public abstract class PfConcept implements Serializable, Comparable<PfConcept> {
     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.
+     * 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 it's contained concepts
+     * @return the keys used by this concept and its contained concepts
      */
     public abstract List<PfKey> getKeys();
 
@@ -71,50 +68,25 @@ public abstract class PfConcept implements Serializable, Comparable<PfConcept> {
      * Validate that this concept is structurally correct.
      *
      * @param result the parameter in which the result of the validation will be returned
-     * @return the validation result that was passed in in the @{link result} field with the result
-     *         of this validation added
+     * @return the validation result that was passed in in the @{link result} field with the result of this validation
+     *         added
      */
-    public abstract PfValidationResult validate(PfValidationResult result);
+    public abstract PfValidationResult validate(@NonNull final PfValidationResult result);
 
     /**
-     * Clean this concept, tidy up any superfluous information such as leading and trailing white
-     * space.
+     * Clean this concept, tidy up any superfluous information such as leading and trailing white space.
      */
     public abstract void clean();
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#equals(java.lang.Object)
-     */
     @Override
     public abstract boolean equals(Object otherObject);
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
-     */
     @Override
     public abstract String toString();
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#hashCode()
-     */
     @Override
     public abstract int hashCode();
 
-    /**
-     * Copy this concept to another object. The target object must have the same class as the source
-     * object.
-     *
-     * @param target the target object to which this object is copied
-     * @return the copied object
-     */
-    public abstract PfConcept copyTo(PfConcept target);
-
     /**
      * Gets the ID string of this concept.
      *
@@ -124,15 +96,31 @@ public abstract class PfConcept implements Serializable, Comparable<PfConcept> {
         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(final String id) {
-        Assertions.argumentNotNull(id, "id may not be null");
-
+    public final boolean matchesId(@NonNull final String id) {
         // Check the ID
         return getId().equals(id);
     }