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 --- .../org/onap/policy/apex/core/protocols/Message.java | 18 ++++++------------ .../engdep/messages/EngineServiceInfoResponse.java | 8 ++++---- .../core/protocols/engdep/messages/GetEngineInfo.java | 6 ++---- .../engdep/messages/GetEngineServiceInfo.java | 6 ++---- .../protocols/engdep/messages/GetEngineStatus.java | 6 ++---- .../apex/core/protocols/engdep/messages/Response.java | 14 ++++++-------- .../core/protocols/engdep/messages/StartEngine.java | 6 ++---- .../protocols/engdep/messages/StartPeriodicEvents.java | 6 ++---- .../core/protocols/engdep/messages/StopEngine.java | 6 ++---- .../protocols/engdep/messages/StopPeriodicEvents.java | 6 ++---- .../core/protocols/engdep/messages/UpdateModel.java | 14 ++++++-------- .../onap/policy/apex/core/protocols/DummyAction.java | 4 ++-- 12 files changed, 38 insertions(+), 62 deletions(-) (limited to 'core/core-protocols') diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/Message.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/Message.java index 95f786cad..ad025555b 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/Message.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/Message.java @@ -140,10 +140,8 @@ public abstract class Message implements Serializable { return messageData; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(final Object object) { @@ -166,10 +164,8 @@ public abstract class Message implements Serializable { } - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -179,10 +175,8 @@ public abstract class Message implements Serializable { return result; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/EngineServiceInfoResponse.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/EngineServiceInfoResponse.java index 4cac23158..0df23d399 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/EngineServiceInfoResponse.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/EngineServiceInfoResponse.java @@ -128,8 +128,8 @@ public class EngineServiceInfoResponse extends Response { this.apexModelKey = apexModelKey; } - /* (non-Javadoc) - * @see java.lang.Object#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -141,8 +141,8 @@ public class EngineServiceInfoResponse extends Response { return result; } - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(Object obj) { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineInfo.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineInfo.java index 5b53856d8..453e037ed 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineInfo.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineInfo.java @@ -51,10 +51,8 @@ public class GetEngineInfo extends Message { super(EngDepAction.GET_ENGINE_INFO, engineKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineServiceInfo.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineServiceInfo.java index bdab1ce9f..1f44e9ce7 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineServiceInfo.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineServiceInfo.java @@ -51,10 +51,8 @@ public class GetEngineServiceInfo extends Message { super(EngDepAction.GET_ENGINE_SERVICE_INFO, nullKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineStatus.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineStatus.java index 59c345647..17846ec2c 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineStatus.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/GetEngineStatus.java @@ -51,10 +51,8 @@ public class GetEngineStatus extends Message { super(EngDepAction.GET_ENGINE_STATUS, engineKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/Response.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/Response.java index c9d4239a1..ddd2c8cb9 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/Response.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/Response.java @@ -80,8 +80,8 @@ public class Response extends Message { return responseTo; } - /* (non-Javadoc) - * @see java.lang.Object#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -92,8 +92,8 @@ public class Response extends Message { return result; } - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(Object obj) { @@ -115,10 +115,8 @@ public class Response extends Message { return successful == other.successful; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartEngine.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartEngine.java index 81353236f..60c26762b 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartEngine.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartEngine.java @@ -51,10 +51,8 @@ public class StartEngine extends Message { super(EngDepAction.START_ENGINE, engineKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartPeriodicEvents.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartPeriodicEvents.java index 32b0be4d0..f50a8e23f 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartPeriodicEvents.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StartPeriodicEvents.java @@ -51,10 +51,8 @@ public class StartPeriodicEvents extends Message { super(EngDepAction.START_PERIODIC_EVENTS, engineKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopEngine.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopEngine.java index 33e66ba6d..844203180 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopEngine.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopEngine.java @@ -51,10 +51,8 @@ public class StopEngine extends Message { super(EngDepAction.STOP_ENGINE, engineKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopPeriodicEvents.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopPeriodicEvents.java index 49f80ecb0..464c85e89 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopPeriodicEvents.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/StopPeriodicEvents.java @@ -51,10 +51,8 @@ public class StopPeriodicEvents extends Message { super(EngDepAction.STOP_PERIODIC_EVENTS, engineKey, messageData); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/UpdateModel.java b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/UpdateModel.java index e29889ea8..741d4736e 100644 --- a/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/UpdateModel.java +++ b/core/core-protocols/src/main/java/org/onap/policy/apex/core/protocols/engdep/messages/UpdateModel.java @@ -88,18 +88,16 @@ public class UpdateModel extends Message { return forceInstall; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.core.model.protocols.Message#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { return "UpdateModel {" + super.toString() + "}[]"; } - /* (non-Javadoc) - * @see java.lang.Object#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -110,8 +108,8 @@ public class UpdateModel extends Message { return result; } - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(Object obj) { diff --git a/core/core-protocols/src/test/java/org/onap/policy/apex/core/protocols/DummyAction.java b/core/core-protocols/src/test/java/org/onap/policy/apex/core/protocols/DummyAction.java index 9f63e5294..bc8d5e5c1 100644 --- a/core/core-protocols/src/test/java/org/onap/policy/apex/core/protocols/DummyAction.java +++ b/core/core-protocols/src/test/java/org/onap/policy/apex/core/protocols/DummyAction.java @@ -34,8 +34,8 @@ public class DummyAction implements Action { this.actionString = actionString; } - /* (non-Javadoc) - * @see org.onap.policy.apex.core.protocols.Action#getActionString() + /** + * {@inheritDoc}. */ @Override public String getActionString() { -- cgit 1.2.3-korg