From 423e98641ca7fe79a1b1bb897aa8a4b17ba5ee4d Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 28 Jun 2019 10:42:34 +0000 Subject: 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 --- .../context/entities/ArtifactKeyTestEntity.java | 58 ++++--------- .../context/entities/ReferenceKeyTestEntity.java | 58 ++++--------- .../context/lock/modifier/NoLockAlbumModifier.java | 7 +- .../lock/modifier/ReadLockAlbumModifier.java | 7 +- .../SingleValueWriteLockAlbumModifier.java | 7 +- .../lock/modifier/WriteLockAlbumModifier.java | 7 +- .../locking/ConcurrentContextJvmThread.java | 6 +- .../context/locking/ConcurrentContextThread.java | 6 +- .../context/utils/ConfigrationProviderImpl.java | 96 +++++++--------------- .../context/utils/IntegrationThreadFactory.java | 4 +- 10 files changed, 81 insertions(+), 175 deletions(-) (limited to 'testsuites/integration/integration-context-test/src/test/java') diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ArtifactKeyTestEntity.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ArtifactKeyTestEntity.java index 1f3ea3c20..f93f914be 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ArtifactKeyTestEntity.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ArtifactKeyTestEntity.java @@ -77,20 +77,16 @@ public class ArtifactKeyTestEntity extends AxConcept { this.doubleValue = doubleValue; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey() + /** + * {@inheritDoc}. */ @Override public AxArtifactKey getKey() { return key; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -133,44 +129,32 @@ public class ArtifactKeyTestEntity extends AxConcept { this.doubleValue = doubleValue; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#validate(org.onap.policy.apex.model.basicmodel.concepts. - * AxValidationResult) + /** + * {@inheritDoc}. */ @Override public AxValidationResult validate(final AxValidationResult result) { return key.validate(result); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { key.clean(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { return "ArtifactKeyTestEntity [key=" + key + ", doubleValue=" + doubleValue + "]"; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#copyTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public AxConcept copyTo(final AxConcept target) { @@ -189,10 +173,8 @@ public class ArtifactKeyTestEntity extends AxConcept { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -202,10 +184,8 @@ public class ArtifactKeyTestEntity extends AxConcept { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(final Object obj) { @@ -229,10 +209,8 @@ public class ArtifactKeyTestEntity extends AxConcept { return (Double.compare(doubleValue, other.doubleValue) == 0); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ReferenceKeyTestEntity.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ReferenceKeyTestEntity.java index 2eef94ed7..1ca64c477 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ReferenceKeyTestEntity.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/entities/ReferenceKeyTestEntity.java @@ -80,20 +80,16 @@ public class ReferenceKeyTestEntity extends AxConcept { this.doubleValue = doubleValue; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey() + /** + * {@inheritDoc}. */ @Override public AxReferenceKey getKey() { return key; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { @@ -136,44 +132,32 @@ public class ReferenceKeyTestEntity extends AxConcept { this.doubleValue = doubleValue; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#validate(org.onap.policy.apex.model.basicmodel.concepts. - * AxValidationResult) + /** + * {@inheritDoc}. */ @Override public AxValidationResult validate(final AxValidationResult result) { return key.validate(result); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { key.clean(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { return "ReferenceKeyTestEntity [key=" + key + ", doubleValue=" + doubleValue + "]"; } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxConcept#copyTo(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept) + /** + * {@inheritDoc}. */ @Override public AxConcept copyTo(final AxConcept target) { @@ -192,10 +176,8 @@ public class ReferenceKeyTestEntity extends AxConcept { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -205,10 +187,8 @@ public class ReferenceKeyTestEntity extends AxConcept { return result; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(final Object obj) { @@ -232,10 +212,8 @@ public class ReferenceKeyTestEntity extends AxConcept { return (Double.compare(doubleValue, other.doubleValue) == 0); } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final AxConcept otherObj) { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/NoLockAlbumModifier.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/NoLockAlbumModifier.java index e541aada7..97ccd0f61 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/NoLockAlbumModifier.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/NoLockAlbumModifier.java @@ -34,11 +34,8 @@ import org.slf4j.ext.XLoggerFactory; public class NoLockAlbumModifier implements AlbumModifier { private static final XLogger LOGGER = XLoggerFactory.getXLogger(NoLockAlbumModifier.class); - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.lock.modifier.AlbumModifier#modifyAlbum(org.onap.policy.apex.context. - * ContextAlbum, int, int) + /** + * {@inheritDoc}. */ @Override public void modifyAlbum(final ContextAlbum contextAlbum, final int loopSize, final int arraySize) { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/ReadLockAlbumModifier.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/ReadLockAlbumModifier.java index e9c435af5..2500017a4 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/ReadLockAlbumModifier.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/ReadLockAlbumModifier.java @@ -35,11 +35,8 @@ import org.slf4j.ext.XLoggerFactory; public class ReadLockAlbumModifier implements AlbumModifier { private static final XLogger LOGGER = XLoggerFactory.getXLogger(ReadLockAlbumModifier.class); - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.lock.modifier.AlbumModifier#modifyAlbum(org.onap.policy.apex.context. - * ContextAlbum, int, int) + /** + * {@inheritDoc}. */ @Override public void modifyAlbum(final ContextAlbum contextAlbum, final int loopSize, final int arraySize) { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/SingleValueWriteLockAlbumModifier.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/SingleValueWriteLockAlbumModifier.java index ad38b03b5..1f6e399a9 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/SingleValueWriteLockAlbumModifier.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/SingleValueWriteLockAlbumModifier.java @@ -35,11 +35,8 @@ import org.slf4j.ext.XLoggerFactory; public class SingleValueWriteLockAlbumModifier implements AlbumModifier { private static final XLogger LOGGER = XLoggerFactory.getXLogger(SingleValueWriteLockAlbumModifier.class); - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.lock.modifier.AlbumModifier#modifyAlbum(org.onap.policy.apex.context. - * ContextAlbum, int, int) + /** + * {@inheritDoc}. */ @Override public void modifyAlbum(final ContextAlbum contextAlbum, final int loopSize, final int arraySize) diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/WriteLockAlbumModifier.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/WriteLockAlbumModifier.java index 552365e92..3fb2901ae 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/WriteLockAlbumModifier.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/lock/modifier/WriteLockAlbumModifier.java @@ -35,11 +35,8 @@ import org.slf4j.ext.XLoggerFactory; public class WriteLockAlbumModifier implements AlbumModifier { private static final XLogger LOGGER = XLoggerFactory.getXLogger(WriteLockAlbumModifier.class); - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.lock.modifier.AlbumModifier#modifyAlbum(org.onap.policy.apex.context. - * ContextAlbum, int, int) + /** + * {@inheritDoc}. */ @Override public void modifyAlbum(final ContextAlbum contextAlbum, final int loopSize, final int arraySize) { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextJvmThread.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextJvmThread.java index 4915e7b89..6d6ea6a58 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextJvmThread.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextJvmThread.java @@ -57,10 +57,8 @@ public class ConcurrentContextJvmThread implements Runnable, Closeable { this.configrationProvider = configrationProvider; } - /* - * (non-Javadoc) - * - * @see java.lang.Runnable#run() + /** + * {@inheritDoc}. */ @Override public void run() { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextThread.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextThread.java index baad04e19..9826de725 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextThread.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/locking/ConcurrentContextThread.java @@ -59,10 +59,8 @@ public class ConcurrentContextThread implements Runnable, Closeable { new ContextParameters(); } - /* - * (non-Javadoc) - * - * @see java.lang.Runnable#run() + /** + * {@inheritDoc}. */ @Override public void run() { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/ConfigrationProviderImpl.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/ConfigrationProviderImpl.java index 0a9a195e9..ad2d0720e 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/ConfigrationProviderImpl.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/ConfigrationProviderImpl.java @@ -71,60 +71,48 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { this.lockType = LockType.getLockType(lockType); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getTestName() + /** + * {@inheritDoc}. */ @Override public String getTestName() { return testType; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getLoopSize() + /** + * {@inheritDoc}. */ @Override public int getLoopSize() { return loopSize; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getThreadCount() + /** + * {@inheritDoc}. */ @Override public int getThreadCount() { return threadCount; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getJvmCount() + /** + * {@inheritDoc}. */ @Override public int getJvmCount() { return jvmCount; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getAlbumSize() + /** + * {@inheritDoc}. */ @Override public int getAlbumSize() { return albumSize; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getExecutorService() + /** + * {@inheritDoc}. */ @Override public ExecutorService getExecutorService() { @@ -133,10 +121,8 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { return Executors.newFixedThreadPool(threadCount, threadFactory); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getExecutorService(java.lang.String, int) + /** + * {@inheritDoc}. */ @Override public ExecutorService getExecutorService(final String threadFactoryName, final int threadPoolSize) { @@ -144,12 +130,8 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { return Executors.newFixedThreadPool(threadPoolSize, threadFactory); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.context.test.utils.ConfigrationProvider#getDistributor(org.onap.policy.apex.model.basicmodel - * .concepts.AxArtifactKey) + /** + * {@inheritDoc}. */ @Override public Distributor getDistributor(final AxArtifactKey key) { @@ -160,10 +142,8 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getDistributor() + /** + * {@inheritDoc}. */ @Override public Distributor getDistributor() { @@ -171,23 +151,17 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { return getDistributor(distributorKey); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getContextAlbum(org.onap.policy.apex.context. - * Distributor) + /** + * {@inheritDoc}. */ @Override public ContextAlbum getContextAlbum(final Distributor distributor) { return getContextAlbum(distributor, Constants.L_TYPE_CONTEXT_ALBUM, Constants.getAxArtifactKeyArray()); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getContextAlbum(org.onap.policy.apex.context. - * Distributor, org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey, - * org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey[]) + /** + * {@inheritDoc}. + *[]) */ @Override public ContextAlbum getContextAlbum(final Distributor distributor, final AxArtifactKey axContextAlbumKey, @@ -204,10 +178,8 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getContextAlbumInitValues() + /** + * {@inheritDoc}. */ @Override public Map getContextAlbumInitValues() { @@ -218,20 +190,16 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { return values; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getAlbumModifier() + /** + * {@inheritDoc}. */ @Override public AlbumModifier getAlbumModifier() { return lockType.getAlbumModifier(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.test.utils.ConfigrationProvider#getLockType() + /** + * {@inheritDoc}. */ @Override public LockType getLockType() { @@ -250,10 +218,8 @@ public class ConfigrationProviderImpl implements ConfigrationProvider { : testType + ":TestConcurrentContextJVMThread_"; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/IntegrationThreadFactory.java b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/IntegrationThreadFactory.java index 271bb9519..a93358d65 100644 --- a/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/IntegrationThreadFactory.java +++ b/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/utils/IntegrationThreadFactory.java @@ -47,8 +47,8 @@ public class IntegrationThreadFactory implements ThreadFactory { this.threadFactoryName = threadFactoryName; } - /* (non-Javadoc) - * @see java.util.concurrent.ThreadFactory#newThread(java.lang.Runnable) + /** + * {@inheritDoc}. */ @Override public Thread newThread(final Runnable runnable) { -- cgit 1.2.3-korg