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 --- .../engine/engine/impl/DummyEnEventListener.java | 7 +- .../core/engine/engine/impl/DummyListener.java | 7 +- .../engine/impl/DummySlowEnEventListener.java | 7 +- .../policy/apex/core/engine/event/DummyAxKey.java | 79 ++++-------- .../engine/executor/context/DummyContextAlbum.java | 140 +++++++-------------- 5 files changed, 76 insertions(+), 164 deletions(-) (limited to 'core/core-engine/src/test/java/org') diff --git a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyEnEventListener.java b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyEnEventListener.java index e67d256fe..b429295ad 100644 --- a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyEnEventListener.java +++ b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyEnEventListener.java @@ -30,11 +30,8 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; */ public class DummyEnEventListener implements EnEventListener { - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.core.engine.engine.EnEventListener#onEnEvent(org.onap.policy.apex.core.engine.event.EnEvent) + /** + * {@inheritDoc}. */ @Override public void onEnEvent(EnEvent enEvent) throws ApexException { diff --git a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyListener.java b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyListener.java index 33b434af1..6256ff498 100644 --- a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyListener.java +++ b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummyListener.java @@ -30,11 +30,8 @@ import org.onap.policy.apex.model.basicmodel.concepts.ApexException; */ public class DummyListener implements EnEventListener { - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.core.engine.engine.EnEventListener#onEnEvent(org.onap.policy.apex.core.engine.event.EnEvent) + /** + * {@inheritDoc}. */ @Override public void onEnEvent(EnEvent enEvent) throws ApexException { diff --git a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummySlowEnEventListener.java b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummySlowEnEventListener.java index fbb38c99e..9b6fc398c 100644 --- a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummySlowEnEventListener.java +++ b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/engine/impl/DummySlowEnEventListener.java @@ -32,11 +32,8 @@ public class DummySlowEnEventListener implements EnEventListener { private long waitTime; - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.core.engine.engine.EnEventListener#onEnEvent(org.onap.policy.apex.core.engine.event.EnEvent) + /** + * {@inheritDoc}. */ @Override public void onEnEvent(EnEvent enEvent) throws ApexException { diff --git a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/event/DummyAxKey.java b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/event/DummyAxKey.java index 0a86c070a..cef1c7bc5 100644 --- a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/event/DummyAxKey.java +++ b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/event/DummyAxKey.java @@ -33,85 +33,64 @@ import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult; public class DummyAxKey extends AxKey { private static final long serialVersionUID = 964899169013353800L; - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(AxConcept concept) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxKey#getId() + /** + * {@inheritDoc}. */ @Override public String getId() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxKey#getCompatibility(org.onap.policy.apex.model.basicmodel. - * concepts.AxKey) + /** + * {@inheritDoc}. */ @Override public Compatibility getCompatibility(AxKey otherKey) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.model.basicmodel.concepts.AxKey#isCompatible(org.onap.policy.apex.model.basicmodel.concepts. - * AxKey) + /** + * {@inheritDoc}. */ @Override public boolean isCompatible(AxKey otherKey) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKey() + /** + * {@inheritDoc}. */ @Override public AxKey getKey() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#getKeys() + /** + * {@inheritDoc}. */ @Override public List getKeys() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (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(AxValidationResult result) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#clean() + /** + * {@inheritDoc}. */ @Override public void clean() { @@ -119,42 +98,32 @@ public class DummyAxKey extends AxKey { } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(Object otherObject) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { return "Dummy Key"; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (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(AxConcept target) { diff --git a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/context/DummyContextAlbum.java b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/context/DummyContextAlbum.java index 5d5583ff6..9dd5cada2 100644 --- a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/context/DummyContextAlbum.java +++ b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/context/DummyContextAlbum.java @@ -47,232 +47,184 @@ public class DummyContextAlbum implements ContextAlbum { this.key = key; } - /* - * (non-Javadoc) - * - * @see java.util.Map#clear() + /** + * {@inheritDoc}. */ @Override public void clear() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#containsKey(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean containsKey(Object key) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#containsValue(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean containsValue(Object value) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#entrySet() + /** + * {@inheritDoc}. */ @Override public Set> entrySet() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#get(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public Object get(Object key) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#isEmpty() + /** + * {@inheritDoc}. */ @Override public boolean isEmpty() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#keySet() + /** + * {@inheritDoc}. */ @Override public Set keySet() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#put(java.lang.Object, java.lang.Object) + /** + * {@inheritDoc}. */ @Override public Object put(String key, Object value) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#putAll(java.util.Map) + /** + * {@inheritDoc}. */ @Override public void putAll(Map map) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#remove(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public Object remove(Object key) { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#size() + /** + * {@inheritDoc}. */ @Override public int size() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see java.util.Map#values() + /** + * {@inheritDoc}. */ @Override public Collection values() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#getKey() + /** + * {@inheritDoc}. */ @Override public AxArtifactKey getKey() { return key; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#getName() + /** + * {@inheritDoc}. */ @Override public String getName() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#getAlbumDefinition() + /** + * {@inheritDoc}. */ @Override public AxContextAlbum getAlbumDefinition() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#getSchemaHelper() + /** + * {@inheritDoc}. */ @Override public SchemaHelper getSchemaHelper() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#lockForReading(java.lang.String) + /** + * {@inheritDoc}. */ @Override public void lockForReading(String key) throws ContextException { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#lockForWriting(java.lang.String) + /** + * {@inheritDoc}. */ @Override public void lockForWriting(String key) throws ContextException { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#unlockForReading(java.lang.String) + /** + * {@inheritDoc}. */ @Override public void unlockForReading(String key) throws ContextException { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#unlockForWriting(java.lang.String) + /** + * {@inheritDoc}. */ @Override public void unlockForWriting(String key) throws ContextException { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#getUserArtifactStack() + /** + * {@inheritDoc}. */ @Override public AxConcept[] getUserArtifactStack() { throw new NotImplementedException("Not implemented on dummy class"); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.context.ContextAlbum#setUserArtifactStack(org.onap.policy.apex.model.basicmodel.concepts. - * AxConcept[]) + /** + * {@inheritDoc}. */ @Override public void setUserArtifactStack(AxConcept[] userArtifactStack) { // Do nothing } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.context.ContextAlbum#flush() + /** + * {@inheritDoc}. */ @Override public void flush() throws ContextException { -- cgit 1.2.3-korg