Add DOMInstanceNotificationService

[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / DOMNotificationPublishService.java

diff --git a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMNotificationPublishService.java b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMNotificationPublishService.java
index 99bf87141fd93b77b14055134d2352307450770a..f6dcf4789010ab1792b5844cced59b757bbf8b8d 100644 (file)
--- a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMNotificationPublishService.java
+++ b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMNotificationPublishService.java
@@ -14,14 +14,13 @@ import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
 
 /**
- * A {@link DOMService} which allows its user to send {@link DOMNotification}s. It
- * provides two styles of initiating the notification delivery, similar to
- * {@link java.util.concurrent.BlockingQueue}:
- * - a put-style method which waits until the implementation can accept the notification
- *   for delivery, and
- * - an offer-style method, which attempts to enqueue the notification, but allows
- *   the caller to specify that it should never wait, or put an upper bound on how
- *   long it is going to wait.
+ * A {@link DOMService} which allows its user to publish top-level (YANG 1.0) {@link DOMNotification}s. It provides two
+ * styles of initiating the notification delivery, similar to {@link java.util.concurrent.BlockingQueue}:
+ * <ul>
+ *   <li>a put-style method which waits until the implementation can accept the notification for delivery, and</li>
+ *   <li>an offer-style method, which attempts to enqueue the notification, but allows the caller to specify that it
+ *       should never wait, or put an upper bound on how long it is going to wait</li>
+ * </ul>
  */
 public interface DOMNotificationPublishService extends DOMService {
     /**