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, 60 insertions, 143 deletions

diff --git a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/engdep/DummyEngineService.java b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/engdep/DummyEngineService.java
index aa6eb3bb7..ef54e8e0e 100644
--- a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/engdep/DummyEngineService.java
+++ b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/engdep/DummyEngineService.java
@@ -46,51 +46,40 @@ public class DummyEngineService implements EngineService {
     private int modelKeyGetCalled;
     private AxArtifactKey updateModelKey;
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#registerActionListener(java.lang.String,
-     * org.onap.policy.apex.service.engine.runtime.ApexEventListener)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void registerActionListener(String listenerName, ApexEventListener listener) {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#deregisterActionListener(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void deregisterActionListener(String listenerName) {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#getEngineServiceEventInterface()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public EngineServiceEventInterface getEngineServiceEventInterface() {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#getKey()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxArtifactKey getKey() {
         return new AxArtifactKey("DummyEngineService:0.0.1");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#getEngineKeys()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Collection<AxArtifactKey> getEngineKeys() {
@@ -99,10 +88,8 @@ public class DummyEngineService implements EngineService {
         return keys;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#getApexModelKey()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxArtifactKey getApexModelKey() {
@@ -111,11 +98,8 @@ public class DummyEngineService implements EngineService {
         return new AxArtifactKey("DummyApexModelKey:0.0.1");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#updateModel(org.onap.policy.apex.model.basicmodel.
-     * concepts.AxArtifactKey, java.lang.String, boolean)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void updateModel(AxArtifactKey engineServiceKey, String apexModelString, boolean forceFlag)
@@ -123,11 +107,8 @@ public class DummyEngineService implements EngineService {
         updateModelKey = engineServiceKey;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#updateModel(org.onap.policy.apex.model.basicmodel.
-     * concepts.AxArtifactKey, org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel, boolean)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void updateModel(AxArtifactKey engineServiceKey, AxPolicyModel apexModel, boolean forceFlag)
@@ -135,148 +116,111 @@ public class DummyEngineService implements EngineService {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#getState()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxEngineState getState() {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#startAll()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void startAll() throws ApexException {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.runtime.EngineService#start(org.onap.policy.apex.model.basicmodel.concepts.
-     * AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void start(AxArtifactKey engineKey) throws ApexException {
         startEngineKey = engineKey;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#stop()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void stop() throws ApexException {
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.runtime.EngineService#stop(org.onap.policy.apex.model.basicmodel.concepts.
-     * AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void stop(AxArtifactKey engineKey) throws ApexException {
         stopEngineKey = engineKey;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#clear()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void clear() throws ApexException {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.runtime.EngineService#clear(org.onap.policy.apex.model.basicmodel.concepts.
-     * AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void clear(AxArtifactKey engineKey) throws ApexException {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#isStarted()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean isStarted() {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#isStarted(org.onap.policy.apex.model.basicmodel.
-     * concepts.AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean isStarted(AxArtifactKey engineKey) {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#isStopped()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean isStopped() {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#isStopped(org.onap.policy.apex.model.basicmodel.
-     * concepts.AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean isStopped(AxArtifactKey engineKey) {
         throw new NotImplementedException("Not implemented on dummy class");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#startPeriodicEvents(long)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void startPeriodicEvents(long period) throws ApexException {
         periodicPeriod = period;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#stopPeriodicEvents()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void stopPeriodicEvents() throws ApexException {
         periodicPeriod = 0;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.runtime.EngineService#getStatus(org.onap.policy.apex.model.basicmodel.
-     * concepts.AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String getStatus(AxArtifactKey engineKey) throws ApexException {
@@ -284,12 +228,8 @@ public class DummyEngineService implements EngineService {
         return "The Status";
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.runtime.EngineService#getRuntimeInfo(org.onap.policy.apex.model.basicmodel.
-     * concepts.AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String getRuntimeInfo(AxArtifactKey engineKey) throws ApexException {
diff --git a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperCarrierTechnologyParameters.java b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperCarrierTechnologyParameters.java
index ccde5199a..6acca2702 100644
--- a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperCarrierTechnologyParameters.java
+++ b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperCarrierTechnologyParameters.java
@@ -449,20 +449,16 @@ public class SuperDooperCarrierTechnologyParameters extends CarrierTechnologyPar
         this.valueDeserializer = valueDeserializer;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.common.parameters.ParameterGroup#getName()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String getName() {
         return this.getLabel();
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.apps.uservice.parameters.ApexParameterValidator#validate()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public GroupValidationResult validate() {
diff --git a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventSubscriber.java b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventSubscriber.java
index c791d31e1..6c5d55183 100644
--- a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventSubscriber.java
+++ b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventSubscriber.java
@@ -49,23 +49,16 @@ public class SuperDooperEventSubscriber implements ApexEventConsumer {
         return name;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#getPeeredReference(org.onap.
-     * policy.apex .service.parameters.eventhandler.EventHandlerPeeredMode)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
         return null;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#setPeeredReference(org.onap.
-     * policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode,
-     * org.onap.policy.apex.service.engine.event.PeeredReference)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {}
diff --git a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperTokenDelimitedEventConverter.java b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperTokenDelimitedEventConverter.java
index e807f7fb5..678961dea 100644
--- a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperTokenDelimitedEventConverter.java
+++ b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperTokenDelimitedEventConverter.java
@@ -29,24 +29,16 @@ import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParame
 
 public final class SuperTokenDelimitedEventConverter implements ApexEventProtocolConverter {
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String,
-     * java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public List<ApexEvent> toApexEvent(final String eventName, final Object eventOfOtherType) throws ApexException {
         return null;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent(org.onap.policy.
-     * apex.service.engine.event.ApexEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String fromApexEvent(final ApexEvent apexEvent) throws ApexException {
diff --git a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/runtime/impl/DummyApexEventListener.java b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/runtime/impl/DummyApexEventListener.java
index b3db3946f..92b5bcd67 100644
--- a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/runtime/impl/DummyApexEventListener.java
+++ b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/runtime/impl/DummyApexEventListener.java
@@ -28,12 +28,8 @@ import org.onap.policy.apex.service.engine.runtime.ApexEventListener;
  */
 public class DummyApexEventListener implements ApexEventListener {
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.runtime.ApexEventListener#onApexEvent(org.onap.policy.apex.service.engine.
-     * event.ApexEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void onApexEvent(ApexEvent apexEvent) {