Replace non-Javadoc comments with inheritDocs

Copyright headers not changed as this review only amends comments.

Issue-ID: POLICY-1791
Change-Id: Icbeb2c6e591b3b160ae102bb67aef2d407924a4d
Signed-off-by: liamfallon <liam.fallon@est.tech>

5 files changed, 64 insertions, 137 deletions

diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/context/ApexInternalContext.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/context/ApexInternalContext.java
index 8eb92a0f8..3d6a72451 100644
--- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/context/ApexInternalContext.java
+++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/context/ApexInternalContext.java
@@ -173,10 +173,8 @@ public class ApexInternalContext implements AxConceptGetter<ContextAlbum> {
         contextDistributor.clear();
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String toString() {
@@ -184,52 +182,40 @@ public class ApexInternalContext implements AxConceptGetter<ContextAlbum> {
                 + ", currentPolicyKey=" + currentPolicyKey + "]";
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#get(org.onap.policy.apex.core.basicmodel.concepts.
-     * AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public ContextAlbum get(final AxArtifactKey conceptKey) {
         return new AxConceptGetterImpl<>(contextAlbums).get(conceptKey);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#get(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public ContextAlbum get(final String conceptKeyName) {
         return new AxConceptGetterImpl<>(contextAlbums).get(conceptKeyName);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#get(java.lang.String, java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public ContextAlbum get(final String conceptKeyName, final String conceptKeyVersion) {
         return new AxConceptGetterImpl<>(contextAlbums).get(conceptKeyName, conceptKeyVersion);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#getAll(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Set<ContextAlbum> getAll(final String conceptKeyName) {
         return new AxConceptGetterImpl<>(contextAlbums).getAll(conceptKeyName);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.basicmodel.concepts.AxConceptGetter#getAll(java.lang.String, java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Set<ContextAlbum> getAll(final String conceptKeyName, final String conceptKeyVersion) {
diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/engine/impl/ApexEngineImpl.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/engine/impl/ApexEngineImpl.java
index bf4219390..87ce1230e 100644
--- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/engine/impl/ApexEngineImpl.java
+++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/engine/impl/ApexEngineImpl.java
@@ -101,12 +101,8 @@ public class ApexEngineImpl implements ApexEngine {
         LOGGER.exit("ApexEngine()<-" + key.getId() + "," + state);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.engine.ApexEngine#updateModel(org.onap.policy.apex.model.policymodel.concepts.
-     * AxPolicyModel)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void updateModel(final AxPolicyModel apexModel) throws ApexException {
@@ -154,10 +150,8 @@ public class ApexEngineImpl implements ApexEngine {
         LOGGER.exit(UPDATE_MODEL + key.getId());
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#start()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void start() throws ApexException {
@@ -195,10 +189,8 @@ public class ApexEngineImpl implements ApexEngine {
         LOGGER.exit("start()" + key);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#stop()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void stop() throws ApexException {
@@ -250,10 +242,8 @@ public class ApexEngineImpl implements ApexEngine {
         throw new ApexException(STOP + key.getId() + "," + state + ", error stopping engine, engine stop timed out");
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#clear()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void clear() throws ApexException {
@@ -273,11 +263,8 @@ public class ApexEngineImpl implements ApexEngine {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#createEvent(org.onap.policy.apex.core.model.concepts.
-     * AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public EnEvent createEvent(final AxArtifactKey eventKey) {
@@ -295,11 +282,8 @@ public class ApexEngineImpl implements ApexEngine {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.engine.ApexEngine#handleEvent(org.onap.policy.apex.core.engine.event.EnEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean handleEvent(final EnEvent incomingEvent) {
@@ -361,11 +345,8 @@ public class ApexEngineImpl implements ApexEngine {
         return ret;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#addEventListener(java.lang.String,
-     * org.onap.policy.apex.core.engine.engine.EnEventListener)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void addEventListener(final String listenerName, final EnEventListener listener) {
@@ -384,10 +365,8 @@ public class ApexEngineImpl implements ApexEngine {
         eventListeners.put(listenerName, listener);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#removeEventListener(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void removeEventListener(final String listenerName) {
@@ -400,30 +379,24 @@ public class ApexEngineImpl implements ApexEngine {
         eventListeners.remove(listenerName);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#getKey()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxArtifactKey getKey() {
         return key;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#getState()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public final AxEngineState getState() {
         return state;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#getEngineStatus()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxEngineModel getEngineStatus() {
@@ -434,10 +407,8 @@ public class ApexEngineImpl implements ApexEngine {
         return engineModel;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.engine.ApexEngine#getEngineRuntime()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Map<AxArtifactKey, Map<String, Object>> getEngineContext() {
diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnEvent.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnEvent.java
index b7afedfea..d53fdf8ff 100644
--- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnEvent.java
+++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnEvent.java
@@ -217,10 +217,8 @@ public class EnEvent extends HashMap<String, Object> {
         userArtifactStack = usedArtifactStackArray;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#get(java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object get(final Object key) {
@@ -245,10 +243,8 @@ public class EnEvent extends HashMap<String, Object> {
         return item;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#values()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Collection<Object> values() {
@@ -263,10 +259,8 @@ public class EnEvent extends HashMap<String, Object> {
         return valueList;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#entrySet()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Set<Map.Entry<String, Object>> entrySet() {
@@ -281,10 +275,8 @@ public class EnEvent extends HashMap<String, Object> {
         return entrySet;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#put(java.lang.Object, java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object put(final String key, final Object incomingValue) {
@@ -316,10 +308,8 @@ public class EnEvent extends HashMap<String, Object> {
         return super.put(key, valueToAssign);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#putAll(java.util.Map)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void putAll(final Map<? extends String, ? extends Object> incomingMap) {
@@ -329,10 +319,8 @@ public class EnEvent extends HashMap<String, Object> {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#remove(java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object remove(final Object key) {
@@ -354,10 +342,8 @@ public class EnEvent extends HashMap<String, Object> {
         return removedValue;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.Map#clear()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void clear() {
@@ -370,10 +356,8 @@ public class EnEvent extends HashMap<String, Object> {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.AbstractMap#toString()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String toString() {
@@ -381,8 +365,8 @@ public class EnEvent extends HashMap<String, Object> {
                 + super.toString() + "]";
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Object#hashCode()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public int hashCode() {
@@ -392,8 +376,8 @@ public class EnEvent extends HashMap<String, Object> {
         return result;
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Object#equals(java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean equals(Object obj) {
diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnField.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnField.java
index a4b221897..e7d4643fd 100644
--- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnField.java
+++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/event/EnField.java
@@ -117,10 +117,8 @@ public class EnField implements Serializable {
         return value;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String toString() {
diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/impl/ExecutorFactoryImpl.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/impl/ExecutorFactoryImpl.java
index 7bc437907..6565060c1 100644
--- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/impl/ExecutorFactoryImpl.java
+++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/impl/ExecutorFactoryImpl.java
@@ -89,12 +89,8 @@ public class ExecutorFactoryImpl implements ExecutorFactory {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.executor.ExecutorFactory#getTaskSelectionExecutor(org.onap.policy.apex.core.
-     * model. concepts.AxState, org.onap.policy.apex.core.engine.context.Context)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public TaskSelectExecutor getTaskSelectionExecutor(final Executor<?, ?, ?, ?> parentExecutor, final AxState state,
@@ -114,11 +110,8 @@ public class ExecutorFactoryImpl implements ExecutorFactory {
         return tsExecutor;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.engine.executor.ExecutorFactory#getTaskExecutor(org.onap.policy.apex.core.model.
-     * concepts. AxTask, org.onap.policy.apex.core.engine.context.Context)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public TaskExecutor getTaskExecutor(final Executor<?, ?, ?, ?> parentExecutor, final AxTask task,
@@ -132,13 +125,8 @@ public class ExecutorFactoryImpl implements ExecutorFactory {
         return taskExecutor;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.executor.ExecutorFactory#getStateFinalizerExecutor(org.onap.policy.apex.core.
-     * engine. executor.Executor, org.onap.policy.apex.core.policymodel.concepts.AxStateFinalizerLogic,
-     * org.onap.policy.apex.core.engine.context.ApexInternalContext)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public StateFinalizerExecutor getStateFinalizerExecutor(final Executor<?, ?, ?, ?> parentExecutor,