aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java
diff options
context:
space:
mode:
Diffstat (limited to 'policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java')
-rw-r--r--policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java21
1 files changed, 10 insertions, 11 deletions
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java
index ed15ddf7..80664554 100644
--- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/TopicBase.java
@@ -32,50 +32,49 @@ import org.slf4j.LoggerFactory;
public abstract class TopicBase implements Topic {
/**
- * logger
+ * Logger.
*/
private static Logger logger = LoggerFactory.getLogger(TopicBase.class);
/**
- * list of servers
+ * List of servers.
*/
protected List<String> servers;
/**
- * Topic
+ * Topic.
*/
protected String topic;
/**
- * event cache
+ * Event cache.
*/
protected CircularFifoQueue<String> recentEvents = new CircularFifoQueue<>(10);
/**
* Am I running? reflects invocation of start()/stop() !locked & start() => alive stop() =>
- * !alive
+ * !alive.
*/
protected volatile boolean alive = false;
/**
* Am I locked? reflects invocation of lock()/unlock() operations locked => !alive (but not in
* the other direction necessarily) locked => !offer, !run, !start, !stop (but this last one is
- * obvious since locked => !alive)
+ * obvious since locked => !alive).
*/
protected volatile boolean locked = false;
/**
- * All my subscribers for new message notifications
+ * All my subscribers for new message notifications.
*/
protected final ArrayList<TopicListener> topicListeners = new ArrayList<>();
/**
- * Instantiates a new Topic Base
+ * Instantiates a new Topic Base.
*
* @param servers list of servers
* @param topic topic name
*
- * @return a Topic Base
* @throws IllegalArgumentException if invalid parameters are present
*/
public TopicBase(List<String> servers, String topic) {
@@ -127,7 +126,7 @@ public abstract class TopicBase implements Topic {
}
/**
- * broadcast event to all listeners
+ * Broadcast event to all listeners.
*
* @param message the event
* @return true if all notifications are performed with no error, false otherwise
@@ -148,7 +147,7 @@ public abstract class TopicBase implements Topic {
}
/**
- * take a snapshot of current topic listeners
+ * Take a snapshot of current topic listeners.
*
* @return the topic listeners
*/