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 --- .../protocol/jms/Apex2JmsObjectEventConverter.java | 13 ++++--------- .../protocol/jms/Apex2JmsTextEventConverter.java | 14 ++++---------- .../event/protocol/xml/Apex2XmlEventConverter.java | 21 ++++++--------------- .../protocol/yaml/Apex2YamlEventConverter.java | 20 ++++++-------------- 4 files changed, 20 insertions(+), 48 deletions(-) (limited to 'plugins/plugins-event/plugins-event-protocol') diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsObjectEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsObjectEventConverter.java index 25aa4f8ee..fe11cdca3 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsObjectEventConverter.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsObjectEventConverter.java @@ -69,10 +69,8 @@ public final class Apex2JmsObjectEventConverter implements ApexEventProtocolConv } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object) + /** + * {@inheritDoc}. */ @Override public List toApexEvent(final String eventName, final Object eventObject) throws ApexEventException { @@ -125,11 +123,8 @@ public final class Apex2JmsObjectEventConverter implements ApexEventProtocolConv return eventList; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent - * (org.onap.policy.apex.service.engine.event.ApexEvent) + /** + * {@inheritDoc}. */ @Override public Object fromApexEvent(final ApexEvent apexEvent) throws ApexEventException { diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsTextEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsTextEventConverter.java index 55548b9d7..b938eaf91 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsTextEventConverter.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/Apex2JmsTextEventConverter.java @@ -40,10 +40,8 @@ import org.slf4j.ext.XLoggerFactory; public final class Apex2JmsTextEventConverter extends Apex2JsonEventConverter { private static final XLogger LOGGER = XLoggerFactory.getXLogger(Apex2JmsTextEventConverter.class); - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object) + /** + * {@inheritDoc}. */ @Override public List toApexEvent(final String eventName, final Object eventObject) throws ApexEventException { @@ -74,12 +72,8 @@ public final class Apex2JmsTextEventConverter extends Apex2JsonEventConverter { return super.toApexEvent(eventName, jmsString); } - /* - * (non-Javadoc) - * - * @see - * org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent(org.onap.policy.apex.service.engine. - * event. ApexEvent) + /** + * {@inheritDoc}. */ @Override public Object fromApexEvent(final ApexEvent apexEvent) throws ApexEventException { diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java index 767c24fdd..cea49001d 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XmlEventConverter.java @@ -94,21 +94,16 @@ public final class Apex2XmlEventConverter implements ApexEventProtocolConverter } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProtocolConverter#init(org.onap.policy.apex.service. - * parameters. eventprotocol.EventProtocolParameters) + /** + * {@inheritDoc}. */ @Override public void init(final EventProtocolParameters parameters) { // No initialization necessary on this class } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object) + /** + * {@inheritDoc}. */ @Override public List toApexEvent(final String eventName, final Object eventObject) throws ApexEventException { @@ -156,12 +151,8 @@ public final class Apex2XmlEventConverter implements ApexEventProtocolConverter return eventList; } - /* - * (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 ApexEventException { diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java index f3afdde32..17c535990 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/main/java/org/onap/policy/apex/plugins/event/protocol/yaml/Apex2YamlEventConverter.java @@ -53,11 +53,8 @@ public class Apex2YamlEventConverter implements ApexEventProtocolConverter { // The parameters for the YAML event protocol private YamlEventProtocolParameters yamlPars; - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProtocolConverter#init(org.onap.policy. - * apex.service.parameters.eventprotocol.EventProtocolParameters) + /** + * {@inheritDoc}. */ @Override public void init(final EventProtocolParameters parameters) { @@ -71,10 +68,8 @@ public class Apex2YamlEventConverter implements ApexEventProtocolConverter { yamlPars = (YamlEventProtocolParameters) parameters; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object) + /** + * {@inheritDoc}. */ @Override public List toApexEvent(final String eventName, final Object eventObject) throws ApexEventException { @@ -127,11 +122,8 @@ public class Apex2YamlEventConverter implements ApexEventProtocolConverter { return eventList; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent(org.onap.policy. - * apex.service.engine.event.ApexEvent) + /** + * {@inheritDoc}. */ @Override public Object fromApexEvent(final ApexEvent apexEvent) throws ApexEventException { -- cgit 1.2.3-korg