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>

6 files changed, 36 insertions, 78 deletions

diff --git a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockFacade.java b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockFacade.java
index 4e6ab71a4..dc8fdb100 100644
--- a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockFacade.java
+++ b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockFacade.java
@@ -57,10 +57,8 @@ public class CuratorLockFacade implements Lock {
         this.lockMutex = lockMutex;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.Lock#lock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void lock() {
@@ -71,20 +69,16 @@ public class CuratorLockFacade implements Lock {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.Lock#lockInterruptibly()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void lockInterruptibly() throws InterruptedException {
         LOGGER.warn("lockInterruptibly() not supported for \"{}\"", lockId);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.Lock#tryLock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean tryLock() {
@@ -97,10 +91,8 @@ public class CuratorLockFacade implements Lock {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.Lock#tryLock(long, java.util.concurrent.TimeUnit)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean tryLock(final long time, final TimeUnit unit) throws InterruptedException {
@@ -113,10 +105,8 @@ public class CuratorLockFacade implements Lock {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.Lock#unlock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void unlock() {
@@ -127,10 +117,8 @@ public class CuratorLockFacade implements Lock {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.Lock#newCondition()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Condition newCondition() {
diff --git a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManager.java b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManager.java
index ce727b8bf..4ab0ca5e8 100644
--- a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManager.java
+++ b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManager.java
@@ -65,11 +65,8 @@ public class CuratorLockManager extends AbstractLockManager {
         LOGGER.exit("CuratorLockManager(): Curator lock manager set up");
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.context.impl.locking.AbstractLockManager#init(org.onap.policy.apex. model.
-     * basicmodel.concepts.AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void init(final AxArtifactKey key) throws ContextException {
@@ -137,11 +134,8 @@ public class CuratorLockManager extends AbstractLockManager {
         LOGGER.exit("init(" + key + "," + curatorLockPars + ")");
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.context.impl.locking.AbstractLockManager#getReentrantReadWriteLock(
-     * java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public ReadWriteLock getReentrantReadWriteLock(final String lockId) throws ContextException {
@@ -154,10 +148,8 @@ public class CuratorLockManager extends AbstractLockManager {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.context.LockManager#shutdown()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void shutdown() {
@@ -173,11 +165,8 @@ public class CuratorLockManager extends AbstractLockManager {
      */
     private class CuratorManagerConnectionStateListener implements ConnectionStateListener {
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see org.apache.curator.framework.state.ConnectionStateListener#stateChanged(org.apache.
-         * curator.framework.CuratorFramework, org.apache.curator.framework.state.ConnectionState)
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public void stateChanged(final CuratorFramework incomngCuratorFramework, final ConnectionState newState) {
diff --git a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManagerParameters.java b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManagerParameters.java
index 39972a7f1..1b525e147 100644
--- a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManagerParameters.java
+++ b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorLockManagerParameters.java
@@ -106,10 +106,8 @@ public class CuratorLockManagerParameters extends LockManagerParameters {
         this.zookeeperContextRetries = zookeeperContextRetries;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.context.parameters.LockManagerParameters#toString()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String toString() {
diff --git a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorReentrantReadWriteLock.java b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorReentrantReadWriteLock.java
index 5a24fb701..08c2deeb7 100644
--- a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorReentrantReadWriteLock.java
+++ b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-curator/src/main/java/org/onap/policy/apex/plugins/context/locking/curator/CuratorReentrantReadWriteLock.java
@@ -68,20 +68,16 @@ public class CuratorReentrantReadWriteLock implements ReadWriteLock {
         return lockId;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.ReadWriteLock#readLock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Lock readLock() {
         return readLockFacade;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.ReadWriteLock#writeLock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Lock writeLock() {
diff --git a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java
index 9d4a5ca8f..291392ad6 100644
--- a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java
+++ b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLock.java
@@ -62,20 +62,16 @@ public class HazelcastLock implements ReadWriteLock {
         return lockId;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.ReadWriteLock#readLock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Lock readLock() {
         return readLock;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.util.concurrent.locks.ReadWriteLock#writeLock()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Lock writeLock() {
diff --git a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java
index 4994cf7f5..b868110a4 100644
--- a/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java
+++ b/plugins/plugins-context/plugins-context-locking/plugins-context-locking-hazelcast/src/main/java/org/onap/policy/apex/plugins/context/locking/hazelcast/HazelcastLockManager.java
@@ -53,11 +53,8 @@ public class HazelcastLockManager extends AbstractLockManager {
         LOGGER.exit("HazelcastLockManager(): Hazelcast lock manager set up");
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.context.impl.locking.AbstractLockManager#init(org.onap.policy.apex.
-     * model. basicmodel.concepts.AxArtifactKey)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void init(final AxArtifactKey key) throws ContextException {
@@ -71,12 +68,8 @@ public class HazelcastLockManager extends AbstractLockManager {
         LOGGER.exit("init(" + key + ")");
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.context.impl.locking.AbstractLockManager#getReentrantReadWriteLock(
-     * java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public ReadWriteLock getReentrantReadWriteLock(final String lockId) throws ContextException {
@@ -88,10 +81,8 @@ public class HazelcastLockManager extends AbstractLockManager {
         }
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.core.context.LockManager#shutdown()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void shutdown() {