Clean up netconf-notifications-api

Pass through the documentation and fixup whitespace and Javadocs a bit.

Change-Id: I0bcbf720d54e1f5a682f923b4cbfb99e13108366
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNetconfNotificationListener.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNetconfNotificationListener.java
index ea5e3b623a9db5afe7341608a623aa44c54c0507..98cecb582d7dfc8e80352733c43bc1b0f395ebed 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNetconfNotificationListener.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNetconfNotificationListener.java
@@ -5,21 +5,18 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfSessionEnd;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfSessionStart;
 
-
 /**
- * Listener for base netconf notifications defined in https://tools.ietf.org/html/rfc6470.
- * This listener uses generated classes from yang model defined in RFC6470.
- * It alleviates the provisioning of base netconf notifications from the code.
+ * Listener for base NETCONF notifications defined in <a href="https://www.rfc-editor.org/rfc/rfc6470.html">RFC6470</a>.
+ * This listener uses generated classes from YANG model defined in RFC6470. It alleviates the provisioning of base
+ * NETCONF notifications from the code.
  */
 public interface BaseNetconfNotificationListener {
-
     /**
      * Callback used to notify about a change in used capabilities.
      */
@@ -35,7 +32,5 @@ public interface BaseNetconfNotificationListener {
      */
     void onSessionEnded(NetconfSessionEnd end);
 
-
     // TODO add other base notifications
-
 }

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNotificationPublisherRegistration.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNotificationPublisherRegistration.java
index 799672596044d5dc1b3cd7ff39db6777739e2ade..f8d8152dae9766e990a0cbb63d8e1606c0ef6673 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNotificationPublisherRegistration.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/BaseNotificationPublisherRegistration.java
@@ -5,12 +5,11 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 /**
- * Registration for base notification publisher.
- * This registration allows for publishing of base netconf notifications using generated classes
+ * Registration for base notification publisher. This registration allows for publishing of base netconf notifications
+ * using generated classes
  */
 public interface BaseNotificationPublisherRegistration
         extends NotificationRegistration, BaseNetconfNotificationListener {

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationCollector.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationCollector.java
index 880509645184de4f55eaa73858d79ca9d00ca4e9..b073f87bfbf62b45e5d4ff7c758e425ca41aa2a5 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationCollector.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationCollector.java
@@ -5,25 +5,21 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
 
 /**
- * Collector of all notifications. Base or generic
+ * Collector of all notifications. Base or generic.
  */
 public interface NetconfNotificationCollector {
-
     /**
      * 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
-     *
+     * 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.
      */
     NotificationPublisherRegistration registerNotificationPublisher(Stream stream);
 
@@ -42,7 +38,7 @@ public interface NetconfNotificationCollector {
      * 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
+     * The listener should receive callbacks for each stream available prior to the registration when its registered.
      */
     NotificationRegistration registerStreamListener(NetconfNotificationStreamListener listener);
 
@@ -50,7 +46,6 @@ public interface NetconfNotificationCollector {
      * Simple listener that receives notifications about changes in stream availability.
      */
     interface NetconfNotificationStreamListener {
-
         /**
          * Stream becomes available in the collector (first publisher is registered).
          */

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationListener.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationListener.java
index ff1030ec79121b20788a10e26927ccdb8bd970de..4f5da8d410d11731f3f6cec289580acc68461f50 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationListener.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationListener.java
@@ -11,7 +11,7 @@ import org.opendaylight.netconf.api.messages.NotificationMessage;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
 
 /**
- * Generic listener for netconf notifications.
+ * Generic listener for NETCONF notifications.
  */
 public interface NetconfNotificationListener {
     /**

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationRegistry.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationRegistry.java
index c1167ea25f4085ffb5e9fecd40e03533ca1eb1eb..1831669cb953166e580a1b27a4acd91facb7cdde 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationRegistry.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NetconfNotificationRegistry.java
@@ -5,14 +5,12 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.Streams;
 
 public interface NetconfNotificationRegistry {
-
     /**
      * Add listener for a certain notification type.
      */
@@ -28,5 +26,4 @@ public interface NetconfNotificationRegistry {
      * Get all the streams available.
      */
     Streams getNotificationPublishers();
-
 }

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationListenerRegistration.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationListenerRegistration.java
index 744679988aed3768ec606d93132010fc959d00c7..15a6753e4b9857394ca4c926a0f8ca2bbbe03b9c 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationListenerRegistration.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationListenerRegistration.java
@@ -5,7 +5,6 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 /**

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationPublisherRegistration.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationPublisherRegistration.java
index 06b6e37bec8b037453f78a2180fa47a8daa23317..f0a35b9794fdd51a6b39820743902537b2ac0060 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationPublisherRegistration.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationPublisherRegistration.java
@@ -5,7 +5,6 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 /**

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationRegistration.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationRegistration.java
index 53ca343f05a28863f53a7c4dab7acd65e213196f..b3f26dc77324ff7e470e041f6e43fbb08eb57d31 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationRegistration.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/NotificationRegistration.java
@@ -5,7 +5,6 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 /**

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryNotificationListener.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryNotificationListener.java
index 06955e9205770ba32c6e3ea5fc994bcdcd9335a3..4852cf52c8adabc368d24b28452fe813e38e5b43 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryNotificationListener.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryNotificationListener.java
@@ -5,7 +5,6 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangLibraryChange;
@@ -16,7 +15,6 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.librar
  * This listener uses generated classes from yang model defined in RFC7895.
  */
 public interface YangLibraryNotificationListener {
-
     /**
      * Callback used to notify about a change in the set of modules and submodules supported by the server.
      *

diff --git a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryPublisherRegistration.java b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryPublisherRegistration.java
index e8eb7363caf38fa8a52a13cb02a69a4d80958b55..9c69490233ebe0cb1b18e703a4a905b989450896 100644 (file)
--- a/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryPublisherRegistration.java
+++ b/netconf/netconf-notifications-api/src/main/java/org/opendaylight/netconf/notifications/YangLibraryPublisherRegistration.java
@@ -5,14 +5,12 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.notifications;
 
 /**
- * Registration for yang-library publisher.
- * This registration allows for publishing of yang library notification using generated classes
+ * Registration for yang-library publisher. This registration allows for publishing of YANG library notification using
+ * generated classes
  */
-public interface YangLibraryPublisherRegistration
-        extends NotificationRegistration, YangLibraryNotificationListener {
+public interface YangLibraryPublisherRegistration extends NotificationRegistration, YangLibraryNotificationListener {
 
 }