From a25503c13d9dc46fc7064a51ed139dccb87361f4 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Fri, 28 Feb 2014 13:41:49 +0100 Subject: [PATCH] Add interface documentation Change-Id: I3573d1153a62bfe36a01504198a3d1182d1013c1 Signed-off-by: Robert Varga --- .../sal/binding/api/NotificationListener.java | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationListener.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationListener.java index b3309b7a12..dd454c6620 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationListener.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationListener.java @@ -11,7 +11,21 @@ import java.util.EventListener; import org.opendaylight.yangtools.yang.binding.Notification; +/** + * Interface implemented by objects interested in some sort of Notification. This + * class acts as a base interface for specific listeners which usually are a type + * capture of this interface. + * + * @param Notification type + */ public interface NotificationListener extends EventListener { - + /** + * Invoked to deliver the notification. Note that this method may be invoked + * from a shared thread pool, so implementations SHOULD NOT perform CPU-intensive + * operations and they definitely MUST NOT invoke any potentially blocking + * operations. + * + * @param notification Notification being delivered. + */ void onNotification(T notification); } -- 2.36.6