X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fbinding%2Fapi%2FNotificationService.java;h=8492296fdad63d0d87b9a431bf2e35a8e65d6312;hb=899ccfb2052bc5b2c52828d6ccb04c16f9787784;hp=ba352359cceccc7028b56a2c26be25162e71ec49;hpb=464b8b3ed84c6750905c3ded5dbd9328a18d7652;p=controller.git 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 ba352359cc..8492296fda 100644 --- 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. * + *

* Each YANG module which defines notifications results in a generated interface {ModuleName}Listener * which handles all the notifications defined in the YANG model. Each notification type translates to * a specific method of the form on{NotificationType} 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. + * + *

Dispatch Listener Example

* - *
Dispatch Listener Example
*

* Lets assume we have following YANG model: * @@ -39,15 +41,16 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener; * } * * + *

* The generated interface will be: - *

+ * {@code
  *  public interface ExampleListener extends NotificationListener {
  *      void onStart(Start notification);
  *      void onStop(Stop notification);
  *  }
- * 
+ * } * The following defines an implementation of the generated interface: - *
+ * {@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
  *      }
  *  }
- * 
+ * } * The implementation is registered as follows: - *
+ * {@code
  *  MyExampleListener listener = new MyExampleListener();
  *  ListenerRegistration reg = service.registerNotificationListener( listener );
- * 
+ * } * The onStart method will be invoked when someone publishes a Start notification and * the onStop method will be invoked when someone publishes a Stop 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