Deprecate controller APIs

[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / md / sal / binding / api / NotificationService.java

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java
index ba352359cceccc7028b56a2c26be25162e71ec49..8492296fdad63d0d87b9a431bf2e35a8e65d6312 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java
@@ -13,15 +13,17 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
 /**
  * Notification broker which allows clients to subscribe for and publish YANG-modeled notifications.
  *
+ * <p>
  * Each YANG module which defines notifications results in a generated interface <code>{ModuleName}Listener</code>
  * which handles all the notifications defined in the YANG model. Each notification type translates to
  * a specific method of the form <code>on{NotificationType}</code> on the generated interface.
  * The generated interface also extends the
  * {@link org.opendaylight.yangtools.yang.binding.NotificationListener} interface and implementations
- * are registered using {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)}
- * method.
+ * are registered using
+ *  {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)} method.
+ *
+ * <h3>Dispatch Listener Example</h3>
  *
- * <h5>Dispatch Listener Example</h5>
  * <p>
  * Lets assume we have following YANG model:
  *
@@ -39,15 +41,16 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
  * }
  * </pre>
  *
+ * <p>
  * The generated interface will be:
- * <pre>
+ * {@code
  *  public interface ExampleListener extends NotificationListener {
  *      void onStart(Start notification);
  *      void onStop(Stop notification);
  *  }
- * </pre>
+ * }
  * The following defines an implementation of the generated interface:
- * <pre>
+ * {@code
  *  public class MyExampleListener implements ExampleListener {
  *      public void onStart(Start notification) {
  *          // do something
@@ -57,15 +60,18 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
  *          // do something
  *      }
  *  }
- * </pre>
+ * }
  * The implementation is registered as follows:
- * <pre>
+ * {@code
  *  MyExampleListener listener = new MyExampleListener();
  *  ListenerRegistration<NotificationListener> reg = service.registerNotificationListener( listener );
- * </pre>
+ * }
  * The <code>onStart</code> method will be invoked when someone publishes a <code>Start</code> notification and
  * the <code>onStop</code> method will be invoked when someone publishes a <code>Stop</code> notification.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.NotificationService} instead
  */
+@Deprecated
 public interface NotificationService extends BindingService {
     /**
      * Registers a listener which implements a YANG-generated notification interface derived from