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 --- .../carrier/restclient/ApexRestClientConsumer.java | 44 +++++++--------------- .../carrier/restclient/ApexRestClientProducer.java | 40 ++++++-------------- .../restclient/SupportApexEventReceiver.java | 12 ++---- 3 files changed, 30 insertions(+), 66 deletions(-) (limited to 'plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient') diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientConsumer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientConsumer.java index 39389c297..ed501687b 100644 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientConsumer.java +++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientConsumer.java @@ -103,10 +103,8 @@ public class ApexRestClientConsumer implements ApexEventConsumer, Runnable { client = ClientBuilder.newClient(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#start() + /** + * {@inheritDoc}. */ @Override public void start() { @@ -117,42 +115,32 @@ public class ApexRestClientConsumer implements ApexEventConsumer, Runnable { consumerThread.start(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#getName() + /** + * {@inheritDoc}. */ @Override public String getName() { return name; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#getPeeredReference(org.onap.policy.apex.service. - * parameters. eventhandler.EventHandlerPeeredMode) + /** + * {@inheritDoc}. */ @Override public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) { return peerReferenceMap.get(peeredMode); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventConsumer#setPeeredReference(org.onap.policy.apex.service. - * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference) + /** + * {@inheritDoc}. */ @Override public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) { peerReferenceMap.put(peeredMode, peeredReference); } - /* - * (non-Javadoc) - * - * @see java.lang.Runnable#run() + /** + * {@inheritDoc}. */ @Override public void run() { @@ -173,10 +161,8 @@ public class ApexRestClientConsumer implements ApexEventConsumer, Runnable { client.close(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.apps.uservice.producer.ApexEventConsumer#stop() + /** + * {@inheritDoc}. */ @Override public void stop() { @@ -193,10 +179,8 @@ public class ApexRestClientConsumer implements ApexEventConsumer, Runnable { * @author Liam Fallon (liam.fallon@ericsson.com) */ private class RequestRunner implements Runnable { - /* - * (non-Javadoc) - * - * @see java.lang.Runnable#run() + /** + * {@inheritDoc}. */ @Override public void run() { diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientProducer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientProducer.java index 275f5a8c2..6739d82a9 100644 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientProducer.java +++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/main/java/org/onap/policy/apex/plugins/event/carrier/restclient/ApexRestClientProducer.java @@ -60,11 +60,8 @@ public class ApexRestClientProducer implements ApexEventProducer { // The peer references for this event handler private Map peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class); - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#init(java.lang.String, - * org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters) + /** + * {@inheritDoc}. */ @Override public void init(final String producerName, final EventHandlerParameters producerParameters) @@ -100,43 +97,32 @@ public class ApexRestClientProducer implements ApexEventProducer { client = ClientBuilder.newClient(); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName() + /** + * {@inheritDoc}. */ @Override public String getName() { return name; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service. - * parameters. eventhandler.EventHandlerPeeredMode) + /** + * {@inheritDoc}. */ @Override public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) { return peerReferenceMap.get(peeredMode); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service. - * parameters. eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference) + /** + * {@inheritDoc}. */ @Override public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) { peerReferenceMap.put(peeredMode, peeredReference); } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#sendEvent(long, java.lang. String, - * java.lang.Object) + /** + * {@inheritDoc}. */ @Override public void sendEvent(final long executionId, final Properties executionProperties, final String eventName, @@ -166,10 +152,8 @@ public class ApexRestClientProducer implements ApexEventProducer { } } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#stop() + /** + * {@inheritDoc}. */ @Override public void stop() { diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/SupportApexEventReceiver.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/SupportApexEventReceiver.java index 5459310fa..739a6660a 100644 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/SupportApexEventReceiver.java +++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-restclient/src/test/java/org/onap/policy/apex/plugins/event/carrier/restclient/SupportApexEventReceiver.java @@ -34,10 +34,8 @@ public class SupportApexEventReceiver implements ApexEventReceiver { private Object lastEvent; private int eventCount; - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventReceiver#receiveEvent(long, java.lang.Object) + /** + * {@inheritDoc}. */ @Override public void receiveEvent(final long executionId, final Properties executionProperties, final Object event) @@ -47,10 +45,8 @@ public class SupportApexEventReceiver implements ApexEventReceiver { this.eventCount++; } - /* - * (non-Javadoc) - * - * @see org.onap.policy.apex.service.engine.event.ApexEventReceiver#receiveEvent(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public void receiveEvent(final Properties executionProperties, final Object event) throws ApexEventException { -- cgit 1.2.3-korg