Deprecate all MD-SAL APIs

[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / notify / NotificationPublishService.java

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java
index bb866f276e713151ccf18b0e57e589c65633647f..4c5ae16b0db016a8d970c7eaaf4ebd438cdb50d3 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java
@@ -11,11 +11,13 @@ import java.util.concurrent.ExecutorService;
 
 /**
  * Interface for publishing YANG-modeled notifications.
+ *
  * <p>
  * Users of this interface can publish any YANG-modeled notification which will
  * be delivered to all subscribed listeners.
+ *
  * <p>
- * Prefered way of publishing of notifications is done by invoking {@link #publish(Object)}.
+ * Preferred way of publishing of notifications is done by invoking {@link #publish(Object)}.
  *
  * <p>You may consider using {@link #publish(Object, ExecutorService)} if and only if
  * your use-case requires customized  execution policy or run-to-completion
@@ -25,18 +27,19 @@ import java.util.concurrent.ExecutorService;
  * The metadata required to deliver a notification to the correct listeners is
  * extracted from the published notification.
  *
- *
+ * <p>
  * FIXME: Consider clarification of execution/delivery policy, how it will be
  * affected by Actor model and cluster-wide notifications.
  *
- * @param <N>
- *            the type of notifications
+ * @param <N> the type of notifications
  */
+@Deprecated
 public interface NotificationPublishService<N> {
 
     /**
      * Publishes a notification and notifies subscribed listeners. All listener
      * notifications are done via a default executor.
+     *
      * <p>
      * <b>Note:</b> This call will block when the default executor is saturated
      * and the notification queue for this executor is full.
@@ -49,8 +52,9 @@ public interface NotificationPublishService<N> {
     /**
      * Publishes a notification and notifies subscribed listeners. All listener
      * notifications are done via the provided executor.
+     *
      * <p>
-     * <b>Note:</b> Use only if ineccessary. Consider using
+     * <b>Note:</b> Use only if necessary. Consider using
      * {@link #publish(Object)} for most use-cases.
      *
      * <p>