aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2018-08-10 14:45:45 -0400
committerPamela Dragosh <pdragosh@research.att.com>2018-08-13 10:17:19 -0400
commit269e543ba89dbf553fc66227f7123a302f56b5b4 (patch)
treeb5ac0196770bc6669246953800dc832c6a1b3056 /policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java
parent637993a21e4826c36ac3dab256acf1510b824d82 (diff)
Remove simple checkstyle
Mostly concentrated on the period at the end of summary. But I did clear a few others for longer than 120 characters and placement of methods next to each other. Possibly a few others. I did not clear everything, but will submit a few more reviews to get the others. Issue-ID: POLICY-881 Change-Id: I692a5349d686d52fee4040757cdc2ed8b5cc221b Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java')
-rw-r--r--policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java58
1 files changed, 29 insertions, 29 deletions
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java
index 6d34d32b..034ac66e 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusConsumer.java
@@ -42,12 +42,12 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Wrapper around libraries to consume from message bus
+ * Wrapper around libraries to consume from message bus.
*/
public interface BusConsumer {
/**
- * fetch messages
+ * fetch messages.
*
* @return list of messages
* @throws Exception when error encountered by underlying libraries
@@ -55,7 +55,7 @@ public interface BusConsumer {
public Iterable<String> fetch() throws InterruptedException, IOException;
/**
- * close underlying library consumer
+ * close underlying library consumer.
*/
public void close();
@@ -74,12 +74,12 @@ public interface BusConsumer {
}
/**
- * Cambria based consumer
+ * Cambria based consumer.
*/
public static class CambriaConsumerWrapper implements FilterableBusConsumer {
/**
- * logger
+ * logger.
*/
private static Logger logger = LoggerFactory.getLogger(CambriaConsumerWrapper.class);
@@ -94,29 +94,29 @@ public interface BusConsumer {
private final Object consLocker = new Object();
/**
- * Cambria client
+ * Cambria client.
*/
private CambriaConsumer consumer;
/**
- * Cambria client to use for next fetch
+ * Cambria client to use for next fetch.
*/
private CambriaConsumer newConsumer = null;
/**
- * fetch timeout
+ * fetch timeout.
*/
protected int fetchTimeout;
/**
- * close condition
+ * close condition.
*/
protected Object closeCondition = new Object();
/**
- * Cambria Consumer Wrapper
+ * Cambria Consumer Wrapper.
* BusTopicParam object contains the following parameters
- * servers messaging bus hosts
+ * servers messaging bus hosts.
* topic topic
* apiKey API Key
* apiSecret API Secret
@@ -125,9 +125,9 @@ public interface BusConsumer {
* fetchTimeout Fetch Timeout
* fetchLimit Fetch Limit
*
- * @param busTopicParams
- * @throws GeneralSecurityException
- * @throws MalformedURLException
+ * @param busTopicParams - The parameters for the bus topic
+ * @throws GeneralSecurityException - Security exception
+ * @throws MalformedURLException - Malformed URL exception
*/
public CambriaConsumerWrapper(BusTopicParams busTopicParams) {
@@ -244,12 +244,12 @@ public interface BusConsumer {
}
/**
- * MR based consumer
+ * MR based consumer.
*/
public abstract class DmaapConsumerWrapper implements BusConsumer {
/**
- * logger
+ * logger.
*/
private static Logger logger = LoggerFactory.getLogger(DmaapConsumerWrapper.class);
@@ -259,24 +259,24 @@ public interface BusConsumer {
protected static final String PROTOCOL_PROP = "Protocol";
/**
- * fetch timeout
+ * fetch timeout.
*/
protected int fetchTimeout;
/**
- * close condition
+ * close condition.
*/
protected Object closeCondition = new Object();
/**
- * MR Consumer
+ * MR Consumer.
*/
protected MRConsumerImpl consumer;
/**
- * MR Consumer Wrapper
- * <p>
- * servers messaging bus hosts
+ * MR Consumer Wrapper.
+ *
+ * <p>servers messaging bus hosts
* topic topic
* apiKey API Key
* apiSecret API Secret
@@ -288,7 +288,7 @@ public interface BusConsumer {
* fetchLimit Fetch Limit
*
* @param busTopicParams contains above listed attributes
- * @throws MalformedURLException
+ * @throws MalformedURLException URL should be valid
*/
public DmaapConsumerWrapper(BusTopicParams busTopicParams) throws MalformedURLException {
@@ -360,7 +360,7 @@ public interface BusConsumer {
}
/**
- * MR based consumer
+ * MR based consumer.
*/
public static class DmaapAafConsumerWrapper extends DmaapConsumerWrapper {
@@ -369,10 +369,10 @@ public interface BusConsumer {
private final Properties props;
/**
- * BusTopicParams contain the following parameters
- * MR Consumer Wrapper
- * <p>
- * servers messaging bus hosts
+ * BusTopicParams contain the following parameters.
+ * MR Consumer Wrapper.
+ *
+ * <p>servers messaging bus hosts
* topic topic
* apiKey API Key
* apiSecret API Secret
@@ -384,7 +384,7 @@ public interface BusConsumer {
* fetchLimit Fetch Limit
*
* @param busTopicParams contains above listed params
- * @throws MalformedURLException
+ * @throws MalformedURLException URL should be valid
*/
public DmaapAafConsumerWrapper(BusTopicParams busTopicParams) throws MalformedURLException {