diff options
author | 2018-08-09 10:51:44 +0100 | |
---|---|---|
committer | 2018-08-09 17:56:57 +0100 | |
commit | 4f0e4e0acb23479d705747cf6015d4d820659c78 (patch) | |
tree | bda775f623b47fcc1d8d7203c994c10ab9418ea6 /services/services-engine/src/main/java/org/onap/policy/apex/service/parameters | |
parent | 086f1dcc8d2be436a05932934fd7116b4ec3e729 (diff) |
Checkstyle the services-engine package
Change-Id: I0d7fd6f867ba280953eb4fd0dc2a5ad1779fb045
Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com>
Issue-ID: POLICY-1034
Diffstat (limited to 'services/services-engine/src/main/java/org/onap/policy/apex/service/parameters')
13 files changed, 32 insertions, 32 deletions
diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterException.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterException.java index 229250bcf..2bc064593 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterException.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterException.java @@ -44,9 +44,9 @@ public class ApexParameterException extends ApexException { * exception. * * @param message the message - * @param e the exception that caused this exception to be thrown + * @param ex the exception that caused this exception to be thrown */ - public ApexParameterException(final String message, final Exception e) { - super(message, e); + public ApexParameterException(final String message, final Exception ex) { + super(message, ex); } } diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java index 79f10bdea..31209bf08 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterHandler.java @@ -58,9 +58,12 @@ public class ApexParameterHandler { // Register the adapters for our carrier technologies and event protocols with GSON // @formatter:off final Gson gson = new GsonBuilder() - .registerTypeAdapter(EngineParameters .class, new EngineServiceParametersJSONAdapter()) - .registerTypeAdapter(CarrierTechnologyParameters.class, new CarrierTechnologyParametersJSONAdapter()) - .registerTypeAdapter(EventProtocolParameters .class, new EventProtocolParametersJSONAdapter()) + .registerTypeAdapter(EngineParameters .class, + new EngineServiceParametersJSONAdapter()) + .registerTypeAdapter(CarrierTechnologyParameters.class, + new CarrierTechnologyParametersJSONAdapter()) + .registerTypeAdapter(EventProtocolParameters .class, + new EventProtocolParametersJSONAdapter()) .create(); // @formatter:on parameters = gson.fromJson(new FileReader(arguments.getFullConfigurationFilePath()), ApexParameters.class); diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterRuntimeException.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterRuntimeException.java index 2334a7e60..a4917f1b6 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterRuntimeException.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameterRuntimeException.java @@ -44,9 +44,9 @@ public class ApexParameterRuntimeException extends ApexRuntimeException { * exception. * * @param message the message - * @param e the exception that caused this exception to be thrown + * @param ex the exception that caused this exception to be thrown */ - public ApexParameterRuntimeException(final String message, final Exception e) { - super(message, e); + public ApexParameterRuntimeException(final String message, final Exception ex) { + super(message, ex); } } diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameters.java index 52c6f4960..9c65c0b32 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/ApexParameters.java @@ -36,8 +36,8 @@ import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMo /** * The main container parameter class for an Apex service. - * <p> - * The following parameters are defined: + * + * <p>The following parameters are defined: * <ol> * <li>engineServiceParameters: The parameters for the Apex engine service itself, such as the * number of engine threads to run and the deployment port number to use. @@ -215,7 +215,7 @@ public class ApexParameters extends AbstractParameters implements ApexParameterV } /** - * Validate parameter values for event handlers in a peered mode + * Validate parameter values for event handlers in a peered mode. * * @param eventHandlerType The event handler type we are checking * @param errorMessageBuilder The builder to which to append any error messages @@ -251,7 +251,7 @@ public class ApexParameters extends AbstractParameters implements ApexParameterV } /** - * This method validates that the settings are valid for the given peered mode + * This method validates that the settings are valid for the given peered mode. * * @param errorMessageBuilder The builder to which to append any error messages * @param peeredMode The peered mode to check @@ -281,7 +281,7 @@ public class ApexParameters extends AbstractParameters implements ApexParameterV } /** - * This method validates that the settings are valid for the event handlers on one + * This method validates that the settings are valid for the event handlers on one. * * @param messagePreamble the preamble for messages indicating the peered mode side * @param errorMessageBuilder The builder to which to append any error messages diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java index ba0327de1..025183328 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java @@ -26,8 +26,8 @@ import org.onap.policy.apex.service.parameters.ApexParameterValidator; /** * The default carrier technology parameter class that may be specialized by carrier technology * plugins that require plugin specific parameters. - * <p> - * The following parameters are defined: + * + * <p>The following parameters are defined: * <ol> * <li>label: The label of the carrier technology. * <li>eventProducerPluginClass: The name of the plugin class that will be used by Apex to produce diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParametersJSONAdapter.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParametersJSONAdapter.java index e72a283cd..38abd3c6c 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParametersJSONAdapter.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParametersJSONAdapter.java @@ -55,6 +55,7 @@ public class CarrierTechnologyParametersJSONAdapter // Built in technology parameters private static final Map<String, String> BUILT_IN_CARRIER_TECHNOLOGY_PARMETER_CLASS_MAP = new HashMap<>(); + static { BUILT_IN_CARRIER_TECHNOLOGY_PARMETER_CLASS_MAP.put("FILE", FILECarrierTechnologyParameters.class.getCanonicalName()); diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/engineservice/EngineServiceParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/engineservice/EngineServiceParameters.java index 1db7aeb2d..3a53b59cb 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/engineservice/EngineServiceParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/engineservice/EngineServiceParameters.java @@ -35,8 +35,7 @@ import org.onap.policy.apex.core.engine.EngineParameters; * This class holds the parameters for an Apex Engine Service with multiple engine threads running * multiple engines. * - * <p> - * The following parameters are defined: + * <p>The following parameters are defined: * <ol> * <li>name: The name of the Apex engine service, which can be set to any value that matches the * regular expression {@link org.onap.policy.apex.model.basicmodel.concepts.AxKey#NAME_REGEXP}. diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerParameters.java index 34589f31b..164544b4e 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerParameters.java @@ -30,12 +30,12 @@ import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParame /** * The parameters for a single event producer, event consumer or synchronous event handler. - * <p> - * Event producers, consumers, and synchronous event handlers all use a carrier technology and an + * + * <p>Event producers, consumers, and synchronous event handlers all use a carrier technology and an * event protocol so the actual parameters for each one are the same. Therefore, we use the same * class for the parameters of each one. - * <p> - * The following parameters are defined: + * + * <p>The following parameters are defined: * <ol> * <li>carrierTechnologyParameters: The carrier technology is the type of messaging infrastructure * used to carry events. Examples are File, Kafka or REST. diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerPeeredMode.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerPeeredMode.java index b7ee667f3..39732f53d 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerPeeredMode.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventhandler/EventHandlerPeeredMode.java @@ -23,8 +23,7 @@ package org.onap.policy.apex.service.parameters.eventhandler; /** * This enum specifies the peered mode that an event handler may be in. * - * <p> - * The following values are defined: + * <p>The following values are defined: * <ol> * <li>SYNCHRONOUS: The event handler is tied to another event handler for event handling in APEX, * used for request-response calls where APEX is the receiver. diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParameters.java index 6e66a18e9..66b5c0aae 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParameters.java @@ -27,8 +27,7 @@ import org.onap.policy.apex.service.parameters.ApexParameterValidator; * A default event protocol parameter class that may be specialized by event protocol plugins that * require plugin specific parameters. * - * <p> - * The following parameters are defined: + * <p>The following parameters are defined: * <ol> * <li>label: The label of the event protocol technology. * <li>eventProducerPluginClass: The name of the plugin class that will be used by Apex to produce diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParametersJSONAdapter.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParametersJSONAdapter.java index 1f33db6b8..9d087bf31 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParametersJSONAdapter.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolParametersJSONAdapter.java @@ -56,6 +56,7 @@ public class EventProtocolParametersJSONAdapter // Built in event protocol parameters private static final Map<String, String> BUILT_IN_EVENT_RPOTOCOL_PARMETER_CLASS_MAP = new HashMap<>(); + static { BUILT_IN_EVENT_RPOTOCOL_PARMETER_CLASS_MAP.put("JSON", JSONEventProtocolParameters.class.getCanonicalName()); BUILT_IN_EVENT_RPOTOCOL_PARMETER_CLASS_MAP.put("APEX", ApexEventProtocolParameters.class.getCanonicalName()); diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextCharDelimitedParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextCharDelimitedParameters.java index f8873ada4..7094a3d3f 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextCharDelimitedParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextCharDelimitedParameters.java @@ -26,8 +26,7 @@ import org.onap.policy.apex.service.parameters.ApexParameterValidator; * An event protocol parameter class for character delimited textual event protocols that may be * specialized by event protocol plugins that require plugin specific parameters. * - * <p> - * The following parameters are defined: + * <p>The following parameters are defined: * <ol> * <li>startChar: starting character delimiter for text blocks containing an event. * <li>endChar: ending character delimiter for text blocks containing an event. diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextTokenDelimitedParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextTokenDelimitedParameters.java index 91a6403df..f71ebc6d8 100644 --- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextTokenDelimitedParameters.java +++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/eventprotocol/EventProtocolTextTokenDelimitedParameters.java @@ -26,8 +26,7 @@ import org.onap.policy.apex.service.parameters.ApexParameterValidator; * An event protocol parameter class for token delimited textual event protocols that may be specialized by event * protocol plugins that require plugin specific parameters. * - * <p> - * The following parameters are defined: + * <p>The following parameters are defined: * <ol> * <li>startDelimiterToken: the token string that delimits the start of text blocks that contain events. * <li>endDelimiterToken: the token string that delimits the end of text blocks that contain events, this parameter is @@ -95,7 +94,7 @@ public abstract class EventProtocolTextTokenDelimitedParameters extends EventPro } /** - * Does there have to be a delimiter at the start of the first text block? + * Check if there must be a delimiter at the start of the first text block. * * @return true if there must be a delimiter at the start of the text block */ @@ -104,7 +103,7 @@ public abstract class EventProtocolTextTokenDelimitedParameters extends EventPro } /** - * Sets if there has to be a delimiter at the start of the first text block? + * Sets if there has to be a delimiter at the start of the first text block. * * @param delimiterAtStart * true if there must be a delimiter at the start of the text block |