X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fdom%2Fapi%2FDOMNotificationPublishService.java;h=90aa87849e606013cdfe8660421e7c9efca77487;hp=f80a124a8d08348719a9ab02a79423cc84bb0661;hb=2a6aa1775604906755883f810ee9ea6d5f286135;hpb=a81d98f692b80c45bce3fe6a87e731abfb012a9f

diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java
index f80a124a8d..90aa87849e 100644
--- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java
@@ -10,9 +10,7 @@ package org.opendaylight.controller.md.sal.dom.api;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import java.util.concurrent.TimeUnit;
-import javax.annotation.Nonnegative;
-import javax.annotation.Nonnull;
-import org.opendaylight.controller.sal.core.api.BrokerService;
+import org.eclipse.jdt.annotation.NonNull;
 
 /**
  * A {@link DOMService} which allows its user to send {@link DOMNotification}s. It
@@ -23,13 +21,17 @@ import org.opendaylight.controller.sal.core.api.BrokerService;
  * - 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.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMNotificationPublishService} instead
  */
-public interface DOMNotificationPublishService extends DOMService, BrokerService {
+@Deprecated(forRemoval = true)
+public interface DOMNotificationPublishService extends DOMService {
     /**
      * Well-known value indicating that the implementation is currently not
      * able to accept a notification.
      */
-    ListenableFuture<Object> REJECTED = Futures.immediateFailedFuture(new DOMNotificationRejectedException("Unacceptable blocking conditions encountered"));
+    ListenableFuture<Object> REJECTED = Futures.immediateFailedFuture(
+            new DOMNotificationRejectedException("Unacceptable blocking conditions encountered"));
 
     /**
      * Publish a notification. The result of this method is a {@link ListenableFuture}
@@ -38,6 +40,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * and implementations may use it to convey additional information related to the
      * publishing process.
      *
+     * <p>
      * Abstract subclasses can refine the return type as returning a promise of a
      * more specific type, e.g.:
      *
@@ -46,6 +49,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      *     ListenableFuture<? extends DeliveryStatus> putNotification(DOMNotification notification);
      * }
      *
+     * <p>
      * Once the Future succeeds, the resulting object can be queried for traits using
      * instanceof, e.g:
      *
@@ -58,10 +62,12 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      *     }
      * }
      *
+     * <p>
      * In case an implementation is running out of resources, it can block the calling
      * thread until enough resources become available to accept the notification for
      * processing, or it is interrupted.
      *
+     * <p>
      * Caution: completion here means that the implementation has completed processing
      *          of the notification. This does not mean that all existing registrants
      *          have seen the notification. Most importantly, the delivery process at
@@ -73,7 +79,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * @throws InterruptedException if interrupted while waiting
      * @throws NullPointerException if notification is null.
      */
-    @Nonnull ListenableFuture<?> putNotification(@Nonnull DOMNotification notification) throws InterruptedException;
+    @NonNull ListenableFuture<?> putNotification(@NonNull DOMNotification notification) throws InterruptedException;
 
     /**
      * Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
@@ -90,7 +96,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      *         the implementation from accepting the notification for delivery.
      * @throws NullPointerException if notification is null.
      */
-    @Nonnull ListenableFuture<?> offerNotification(@Nonnull DOMNotification notification);
+    @NonNull ListenableFuture<?> offerNotification(@NonNull DOMNotification notification);
 
     /**
      * Attempt to publish a notification. The result of this method is a {@link ListenableFuture}
@@ -101,7 +107,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * is guaranteed to block more than the specified timeout.
      *
      * @param notification Notification to be published.
-     * @param timeout how long to wait before giving up, in units of unit
+     * @param timeout how long to wait before giving up, in units of unit, must not be negative
      * @param unit a TimeUnit determining how to interpret the timeout parameter
      * @return A listenable future which will report completion when the service
      *         has finished propagating the notification to its immediate registrants,
@@ -111,6 +117,6 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * @throws NullPointerException if notification or unit is null.
      * @throws IllegalArgumentException if timeout is negative.
      */
-    @Nonnull ListenableFuture<?> offerNotification(@Nonnull DOMNotification notification,
-        @Nonnegative long timeout, @Nonnull TimeUnit unit) throws InterruptedException;
+    @NonNull ListenableFuture<?> offerNotification(@NonNull DOMNotification notification,
+        long timeout, @NonNull TimeUnit unit) throws InterruptedException;
 }