Fix policy/common checkstyle issues

The root pom.xml had a syntax error in a declaration. The suppressions
xml was not being found by the sub-modules. It was better to create a
copy in each of the sub-modules where we will not be fixing
abbreviations or the interface declarations in own java file.

Added specific checkstyle files for each submodule.

One interesting note for the InheritDoc tag. It seems that the mvn
compile has a bug that interprets these as missing a period after
the tag. Even though the parent interface has it correctly. It was
easier to just remove it than duplicate.

There are new JIRA's for that work to be done in Dublin.

Fixed some spacing in pom's.

Issue-ID: POLICY-1131
Change-Id: I5f845958ccefd50a3b7290662da43c994870f1f7
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

11 files changed, 15 insertions, 119 deletions

diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java
index ff49a113..fece6463 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * policy-endpoints
  * ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -68,7 +68,7 @@ public interface Topic extends TopicRegisterable, Startable, Lockable {
     /**
      * Gets the communication infrastructure type.
      * 
-     * @return
+     * @return CommInfrastructure object
      */
     public CommInfrastructure getTopicCommInfrastructure();
 
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java
index 30cc923b..d5e04d50 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java
@@ -140,10 +140,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory {
      */
     protected HashMap<String, DmaapTopicSource> dmaapTopicSources = new HashMap<>();
 
-
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public DmaapTopicSource build(BusTopicParams busTopicParams) {
 
@@ -166,9 +162,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory {
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public List<DmaapTopicSource> build(Properties properties) {
 
@@ -383,11 +376,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory {
         return dmaapTopicSourceLst;
     }
 
-    /**
-     * {@inheritDoc}
-     * 
-     * @throws IllegalArgumentException throws illegal argument exception
-     */
     @Override
     public DmaapTopicSource build(List<String> servers, String topic, String apiKey, String apiSecret) {
         return this.build(BusTopicParams.builder()
@@ -403,19 +391,11 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory {
                 .build());
     }
 
-    /**
-     * {@inheritDoc}
-     * 
-     * @throws IllegalArgumentException throws illegal argument exception
-     */
     @Override
     public DmaapTopicSource build(List<String> servers, String topic) {
         return this.build(servers, topic, null, null);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void destroy(String topic) {
 
@@ -448,9 +428,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory {
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public DmaapTopicSource get(String topic) {
 
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java
index 4f62ffa4..f3f3e156 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java
@@ -130,9 +130,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
      */
     protected HashMap<String, UebTopicSource> uebTopicSources = new HashMap<>();
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public UebTopicSource build(BusTopicParams busTopicParams) {
         if (busTopicParams.getServers() == null || busTopicParams.getServers().isEmpty()) {
@@ -158,9 +155,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public List<UebTopicSource> build(Properties properties) {
 
@@ -187,18 +181,19 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
                     continue;
                 }
 
-                List<String> serverList = new ArrayList<>(Arrays.asList(servers.split("\\s*,\\s*")));
+                final List<String> serverList = new ArrayList<>(Arrays.asList(servers.split("\\s*,\\s*")));
 
-                String apiKey = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
-                        + PolicyEndPointProperties.PROPERTY_TOPIC_API_KEY_SUFFIX);
+                final String apiKey = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS 
+                        + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_API_KEY_SUFFIX);
 
-                String apiSecret = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "."
-                        + topic + PolicyEndPointProperties.PROPERTY_TOPIC_API_SECRET_SUFFIX);
+                final String apiSecret = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS 
+                        + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_API_SECRET_SUFFIX);
 
-                String consumerGroup = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "."
-                        + topic + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX);
+                final String consumerGroup = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS 
+                        + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX);
 
-                String consumerInstance = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS
+                final String consumerInstance = properties.getProperty(
+                        PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS
                         + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_INSTANCE_SUFFIX);
 
                 String fetchTimeoutString = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS
@@ -269,9 +264,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
         return newUebTopicSources;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public UebTopicSource build(List<String> servers, String topic, String apiKey, String apiSecret) {
 
@@ -287,17 +279,11 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
                 .allowSelfSignedCerts(true).build());
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public UebTopicSource build(List<String> servers, String topic) {
         return this.build(servers, topic, null, null);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void destroy(String topic) {
 
@@ -330,9 +316,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory {
         }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public UebTopicSource get(String topic) {
 
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java
index aaf0cfb5..716ce95b 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java
@@ -112,9 +112,6 @@ public interface BusPublisher {
             }
         }
 
-        /**
-         * {@inheritDoc}
-         */
         @Override
         public boolean send(String partitionId, String message) {
             if (message == null) {
@@ -130,9 +127,6 @@ public interface BusPublisher {
             return true;
         }
 
-        /**
-         * {@inheritDoc}
-         */
         @Override
         public void close() {
             logger.info("{}: CLOSE", this);
@@ -240,9 +234,6 @@ public interface BusPublisher {
             logger.info("{}: CREATION: using protocol {}", this, protocol.getValue());
         }
 
-        /**
-         * {@inheritDoc}
-         */
         @Override
         public void close() {
             logger.info("{}: CLOSE", this);
@@ -254,9 +245,6 @@ public interface BusPublisher {
             }
         }
 
-        /**
-         * {@inheritDoc}
-         */
         @Override
         public boolean send(String partitionId, String message) {
             if (message == null) {
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java
index 7f03286f..b752d91c 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java
@@ -3,6 +3,7 @@
  * policy-endpoints
  * ================================================================================
  * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
+ * Modifications Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,10 +21,9 @@
 
 package org.onap.policy.common.endpoints.event.comm.bus.internal;
 
-import org.apache.commons.lang3.StringUtils;
-
 import java.util.List;
 import java.util.Map;
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * Member variables of this Params class are as follows.
@@ -174,7 +174,7 @@ public class BusTopicParams {
     }
 
     /**
-     * Methods to Check if the property is INVALID
+     * Methods to Check if the property is INVALID.
      */
 
     boolean isEnvironmentInvalid() {
@@ -231,7 +231,7 @@ public class BusTopicParams {
     }
 
     /**
-     * Methods to Check if the property is Valid
+     * Methods to Check if the property is Valid.
      */
 
     boolean isApiKeyValid() {
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java
index 6e8c4011..c8d6bd5a 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java
@@ -78,9 +78,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi
      */
     public abstract void init();
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean start() {
         logger.info("{}: starting", this);
@@ -102,9 +99,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi
         return true;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean stop() {
 
@@ -129,9 +123,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi
         return true;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean send(String message) {
 
@@ -161,26 +152,16 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi
         return true;
     }
 
-
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void setPartitionKey(String partitionKey) {
         this.partitionId = partitionKey;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public String getPartitionKey() {
         return this.partitionId;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void shutdown() {
         this.stop();
@@ -208,7 +189,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi
         return true;
     }
 
-
     @Override
     public String toString() {
         return "InlineBusTopicSink [partitionId=" + partitionId + ", alive=" + alive + ", publisher=" + publisher + "]";
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java
index eb431229..01531055 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java
@@ -114,9 +114,6 @@ public class InlineDmaapTopicSink extends InlineBusTopicSink implements DmaapTop
         logger.info("{}: DMAAP SINK created", this);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public CommInfrastructure getTopicCommInfrastructure() {
         return Topic.CommInfrastructure.DMAAP;
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java
index b07a1966..f989f808 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java
@@ -80,9 +80,6 @@ public class InlineUebTopicSink extends InlineBusTopicSink implements UebTopicSi
         return builder.toString();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public CommInfrastructure getTopicCommInfrastructure() {
         return Topic.CommInfrastructure.UEB;
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java
index 0482e860..b9463e81 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java
@@ -234,9 +234,6 @@ public abstract class SingleThreadedBusTopicSource extends BusTopicBase
         logger.info("{}: exiting thread", this);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean offer(String event) {
         if (!this.alive) {
@@ -272,42 +269,27 @@ public abstract class SingleThreadedBusTopicSource extends BusTopicBase
                 + topicListeners.size() + ", toString()=" + super.toString() + "]";
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public String getConsumerGroup() {
         return consumerGroup;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public String getConsumerInstance() {
         return consumerInstance;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void shutdown() {
         this.stop();
         this.topicListeners.clear();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int getFetchTimeout() {
         return fetchTimeout;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int getFetchLimit() {
         return fetchLimit;
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java
index 45c0b6fc..8050de2a 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java
@@ -139,9 +139,6 @@ public class SingleThreadedDmaapTopicSource extends SingleThreadedBusTopicSource
         logger.info("{}: INITTED", this);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public CommInfrastructure getTopicCommInfrastructure() {
         return Topic.CommInfrastructure.DMAAP;
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java
index 23d3edca..de6aa860 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java
@@ -36,8 +36,6 @@ public class SingleThreadedUebTopicSource extends SingleThreadedBusTopicSource i
      * @param busTopicParams Parameters object containing all the required inputs
      * @throws IllegalArgumentException An invalid parameter passed in
      */
-
-
     public SingleThreadedUebTopicSource(BusTopicParams busTopicParams) {
 
         super(busTopicParams);
@@ -65,9 +63,6 @@ public class SingleThreadedUebTopicSource extends SingleThreadedBusTopicSource i
                 .allowSelfSignedCerts(this.allowSelfSignedCerts).build());
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public CommInfrastructure getTopicCommInfrastructure() {
         return Topic.CommInfrastructure.UEB;