Bug 8153: Enforce check-style rules for netconf - netconf-notification-api
[netconf.git] / netconf / netconf-notifications-api / src / main / java / org / opendaylight / netconf / notifications / NetconfNotificationCollector.java
index 034e48a5e160cfa9020cd2f9721442977b1622be..34a80b391c7dd71ad4567886ec131e0119b48e3c 100644 (file)
@@ -17,8 +17,9 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.r
 public interface NetconfNotificationCollector {
 
     /**
-     * Add notification publisher for a particular stream
+     * Add notification publisher for a particular stream.
      *
+     * <p>
      * Implementations should allow for multiple publishers of a single stream
      * and its up to implementations to decide how to merge metadata (e.g. description)
      * for the same stream when providing information about available stream
@@ -27,7 +28,7 @@ public interface NetconfNotificationCollector {
     NotificationPublisherRegistration registerNotificationPublisher(Stream stream);
 
     /**
-     * Register base notification publisher
+     * Register base notification publisher.
      */
     BaseNotificationPublisherRegistration registerBaseNotificationPublisher();
 
@@ -35,22 +36,23 @@ public interface NetconfNotificationCollector {
      * Users of the registry have an option to get notification each time new notification stream gets registered
      * This allows for a push model in addition to pull model for retrieving information about available streams.
      *
+     * <p>
      * The listener should receive callbacks for each stream available prior to the registration when its registered
      */
     NotificationRegistration registerStreamListener(NetconfNotificationStreamListener listener);
 
     /**
-     * Simple listener that receives notifications about changes in stream availability
+     * Simple listener that receives notifications about changes in stream availability.
      */
     public interface NetconfNotificationStreamListener {
 
         /**
-         * Stream becomes available in the collector (first publisher is registered)
+         * Stream becomes available in the collector (first publisher is registered).
          */
         void onStreamRegistered(Stream stream);
 
         /**
-         * Stream is not available anymore in the collector (last publisher is unregistered)
+         * Stream is not available anymore in the collector (last publisher is unregistered).
          */
         void onStreamUnregistered(StreamNameType stream);
     }