From 33f2fa88fb64e3ae67dbf5bb098d81b91baef10f Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 27 Jun 2019 15:43:14 +0000 Subject: Add period after inheritDoc for Sonar Issue-ID: POLICY-1791 Change-Id: I60f65fb60ca77fe97bd1c23822038b835bd98a11 Signed-off-by: liamfallon --- .../apex/core/engine/executor/StateExecutor.java | 29 ++++++++++---------- .../engine/executor/StateFinalizerExecutor.java | 30 ++++++++++----------- .../core/engine/executor/StateMachineExecutor.java | 31 +++++++++++----------- .../apex/core/engine/executor/TaskExecutor.java | 30 ++++++++++----------- .../core/engine/executor/TaskSelectExecutor.java | 30 ++++++++++----------- .../core/engine/engine/impl/DummySmExecutor.java | 7 ++--- .../executor/DummyStateFinalizerExecutor.java | 3 ++- .../core/engine/executor/DummyTaskExecutor.java | 7 ++--- .../engine/executor/DummyTaskSelectExecutor.java | 5 ++-- .../plugins/event/carrier/jms/ApexJmsConsumer.java | 11 ++++---- .../eventrequestor/EventRequestorProducer.java | 9 ++++--- .../producer/ApexFileEventProducer.java | 13 ++++----- .../service/engine/main/ApexEventUnmarshaller.java | 5 ++-- .../dummyclasses/SuperDooperEventProducer.java | 13 ++++----- 14 files changed, 117 insertions(+), 106 deletions(-) diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateExecutor.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateExecutor.java index 069c750c0..caaa1842b 100644 --- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateExecutor.java +++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateExecutor.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -92,7 +93,7 @@ public class StateExecutor implements Executor incomingParent, final AxState incomingAxState, @@ -143,7 +144,7 @@ public class StateExecutor implements Executor getParent() { @@ -295,7 +296,7 @@ public class StateExecutor implements Executor incomingNextExecutor) { @@ -335,7 +336,7 @@ public class StateExecutor implements Executor getNext() { @@ -343,7 +344,7 @@ public class StateExecutor implements Executor incomingParent, @@ -91,7 +91,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void prepare() throws StateMachineException { @@ -102,7 +102,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public String execute(final long executionId, final Properties executionProperties, @@ -112,7 +112,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public final void executePre(final long executionId, final Properties executionProperties, @@ -129,7 +129,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public final void executePost(final boolean returnValue) throws StateMachineException, ContextException { @@ -162,7 +162,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void cleanUp() throws StateMachineException { @@ -170,7 +170,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public AxReferenceKey getKey() { @@ -178,7 +178,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Executor getParent() { @@ -186,7 +186,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public AxStateFinalizerLogic getSubject() { @@ -194,7 +194,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public ApexInternalContext getContext() { @@ -202,7 +202,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Map getIncoming() { @@ -210,7 +210,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public String getOutgoing() { @@ -222,7 +222,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setNext( @@ -231,7 +231,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Executor, String, AxStateFinalizerLogic, ApexInternalContext> getNext() { @@ -239,7 +239,7 @@ public abstract class StateFinalizerExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setParameters(final ExecutorParameters parameters) {} diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateMachineExecutor.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateMachineExecutor.java index afc888e8d..73ace3de2 100644 --- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateMachineExecutor.java +++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/StateMachineExecutor.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -70,7 +71,7 @@ public class StateMachineExecutor implements Executor newParent, final AxPolicy newAxPolicy, @@ -107,7 +108,7 @@ public class StateMachineExecutor implements Executor getParent() { @@ -202,7 +203,7 @@ public class StateMachineExecutor implements Executor newNextExecutor) { @@ -242,7 +243,7 @@ public class StateMachineExecutor implements Executor getNext() { @@ -250,7 +251,7 @@ public class StateMachineExecutor implements Executor newParent, final AxTask newAxTask, @@ -92,7 +92,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void prepare() throws StateMachineException { @@ -103,7 +103,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Map execute(final long executionId, final Properties executionProperties, @@ -113,7 +113,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public final void executePre(final long executionId, final Properties executionProperties, @@ -155,7 +155,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public final void executePost(final boolean returnValue) throws StateMachineException, ContextException { @@ -237,7 +237,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void cleanUp() throws StateMachineException { @@ -245,7 +245,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public AxArtifactKey getKey() { @@ -253,7 +253,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Executor getParent() { @@ -261,7 +261,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public AxTask getSubject() { @@ -269,7 +269,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public ApexInternalContext getContext() { @@ -277,7 +277,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Map getIncoming() { @@ -285,7 +285,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Map getOutgoing() { @@ -293,7 +293,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setNext(final Executor, Map, AxTask, ApexInternalContext> nextEx) { @@ -301,7 +301,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public Executor, Map, AxTask, ApexInternalContext> getNext() { @@ -309,7 +309,7 @@ public abstract class TaskExecutor } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setParameters(final ExecutorParameters parameters) {} diff --git a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/TaskSelectExecutor.java b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/TaskSelectExecutor.java index 66ffa9b32..097bc98b5 100644 --- a/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/TaskSelectExecutor.java +++ b/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/executor/TaskSelectExecutor.java @@ -75,7 +75,7 @@ public abstract class TaskSelectExecutor implements Executor newParent, final AxState newAxState, @@ -86,7 +86,7 @@ public abstract class TaskSelectExecutor implements Executor getParent() { @@ -179,7 +179,7 @@ public abstract class TaskSelectExecutor implements Executor newNextExecutor) { @@ -203,7 +203,7 @@ public abstract class TaskSelectExecutor implements Executor getNext() { @@ -211,7 +211,7 @@ public abstract class TaskSelectExecutor implements Executor execute(final long executionId, final Properties executionProperties, @@ -65,7 +66,7 @@ public class DummyTaskExecutor extends TaskExecutor { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public AxTask getSubject() { @@ -78,7 +79,7 @@ public class DummyTaskExecutor extends TaskExecutor { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void cleanUp() throws StateMachineException { diff --git a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/DummyTaskSelectExecutor.java b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/DummyTaskSelectExecutor.java index 03d0b2894..9f9713c9c 100644 --- a/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/DummyTaskSelectExecutor.java +++ b/core/core-engine/src/test/java/org/onap/policy/apex/core/engine/executor/DummyTaskSelectExecutor.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,7 +52,7 @@ public class DummyTaskSelectExecutor extends TaskSelectExecutor { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public AxArtifactKey execute(final long executionId, final Properties executionProperties, @@ -68,7 +69,7 @@ public class DummyTaskSelectExecutor extends TaskSelectExecutor { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void cleanUp() throws StateMachineException { diff --git a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java index 3fd39eedf..b857d8e14 100644 --- a/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java +++ b/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-jms/src/main/java/org/onap/policy/apex/plugins/event/carrier/jms/ApexJmsConsumer.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -143,7 +144,7 @@ public class ApexJmsConsumer implements MessageListener, ApexEventConsumer, Runn } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void start() { @@ -155,7 +156,7 @@ public class ApexJmsConsumer implements MessageListener, ApexEventConsumer, Runn } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public String getName() { @@ -163,7 +164,7 @@ public class ApexJmsConsumer implements MessageListener, ApexEventConsumer, Runn } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) { @@ -225,7 +226,7 @@ public class ApexJmsConsumer implements MessageListener, ApexEventConsumer, Runn } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void onMessage(final Message jmsMessage) { @@ -245,7 +246,7 @@ public class ApexJmsConsumer implements MessageListener, ApexEventConsumer, Runn } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void stop() { diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/eventrequestor/EventRequestorProducer.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/eventrequestor/EventRequestorProducer.java index 9018b91ef..18429dbd2 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/eventrequestor/EventRequestorProducer.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/eventrequestor/EventRequestorProducer.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -104,7 +105,7 @@ public class EventRequestorProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) { @@ -112,7 +113,7 @@ public class EventRequestorProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) { @@ -120,7 +121,7 @@ public class EventRequestorProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void sendEvent(final long executionId, final Properties executorProperties, final String eventName, @@ -159,7 +160,7 @@ public class EventRequestorProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void stop() { diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/producer/ApexFileEventProducer.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/producer/ApexFileEventProducer.java index db8413c6f..5209f6453 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/producer/ApexFileEventProducer.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/producer/ApexFileEventProducer.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -59,7 +60,7 @@ public class ApexFileEventProducer implements ApexEventProducer { new EnumMap<>(EventHandlerPeeredMode.class); /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void init(final String name, final EventHandlerParameters producerParameters) throws ApexEventException { @@ -105,7 +106,7 @@ public class ApexFileEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public String getName() { @@ -113,7 +114,7 @@ public class ApexFileEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) { @@ -121,7 +122,7 @@ public class ApexFileEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) { @@ -129,7 +130,7 @@ public class ApexFileEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void sendEvent(final long executionId, final Properties executionProperties, final String eventName, @@ -158,7 +159,7 @@ public class ApexFileEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void stop() { diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/main/ApexEventUnmarshaller.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/main/ApexEventUnmarshaller.java index 6fdc0fdef..f03b58ca2 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/main/ApexEventUnmarshaller.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/main/ApexEventUnmarshaller.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -178,7 +179,7 @@ public class ApexEventUnmarshaller implements ApexEventReceiver, Runnable { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void receiveEvent(final Properties executionProperties, final Object event) throws ApexEventException { @@ -186,7 +187,7 @@ public class ApexEventUnmarshaller implements ApexEventReceiver, Runnable { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void receiveEvent(final long executionId, final Properties executionProperties, final Object event) diff --git a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventProducer.java b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventProducer.java index ff7d90a40..a188901f3 100644 --- a/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventProducer.java +++ b/services/services-engine/src/test/java/org/onap/policy/apex/service/engine/parameters/dummyclasses/SuperDooperEventProducer.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * Modifications Copyright (C) 2019 Nordix Foundation. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -44,7 +45,7 @@ public class SuperDooperEventProducer implements ApexEventProducer { public SuperDooperEventProducer() {} /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void init(final String name, final EventHandlerParameters producerParameters) throws ApexEventException { @@ -52,7 +53,7 @@ public class SuperDooperEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public String getName() { @@ -60,7 +61,7 @@ public class SuperDooperEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) { @@ -68,13 +69,13 @@ public class SuperDooperEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {} /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void sendEvent(final long executionId, final Properties executionProperties, final String eventName, @@ -84,7 +85,7 @@ public class SuperDooperEventProducer implements ApexEventProducer { } /** - * {@inheritDoc} + * {@inheritDoc}. */ @Override public void stop() {} -- cgit 1.2.3-korg