Updated implementation of broker (data services, generated code), added Integration...

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

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
index 922acb9821f45d6598b1b39606cd04a82681ec3d..10b29f721873bd2bd78573b071f3e771e5549d3c 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
@@ -8,27 +8,63 @@
 package org.opendaylight.controller.sal.binding.api;
 
 import org.opendaylight.controller.md.sal.common.api.notify.NotificationSubscriptionService;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.opendaylight.yangtools.concepts.Registration;
 import org.opendaylight.yangtools.yang.binding.Notification;
 
 public interface NotificationService extends BindingAwareService {
-
+    /**
+     * 
+     * Deprecated: use {@link #addNotificationListener(Class, NotificationListener)} istead.
+     * 
+     * @param listener
+     */
     @Deprecated
     <T extends Notification> void addNotificationListener(Class<T> notificationType, NotificationListener<T> listener);
 
+    /**
+     * 
+     * Deprecated: use {@link #addNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)} istead.
+     * 
+     * @param listener
+     */
     @Deprecated
     void addNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener listener);
 
+    /**
+     * Deprecated: use {@link Registration#close()} istead.
+     * @param listener
+     */
     @Deprecated
     void removeNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener listener);
 
+    /**
+     * Deprecated: use {@link Registration#close()} istead.
+     * @param listener
+     */
     @Deprecated
     <T extends Notification> void removeNotificationListener(Class<T> notificationType, NotificationListener<T> listener);
 
+    
+    /**
+     * Register a generic listener for specified notification type only.
+     * 
+     * @param notificationType
+     * @param listener
+     * @return Registration for listener. To unregister listener invoke {@link Registration#close()} method.
+     */
     <T extends Notification> Registration<NotificationListener<T>> registerNotificationListener(
             Class<T> notificationType, NotificationListener<T> listener);
 
 
+    /**
+     * Register a listener which implements generated notification interfaces derived from
+     * {@link org.opendaylight.yangtools.yang.binding.NotificationListener}.
+     * Listener is registered for all notifications present in implemented interfaces.
+     * 
+     * @param listener
+     * @return Registration for listener. To unregister listener invoke {@link Registration#close()} method.
+     */
     Registration<org.opendaylight.yangtools.yang.binding.NotificationListener> registerNotificationListener(
             org.opendaylight.yangtools.yang.binding.NotificationListener listener);
 }