Deprecated controller fine-grained sharding APIs

[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / md / sal / dom / api / DOMDataTreeProducer.java

diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java
index cbfa0122f2be8bb9cde5f72eff7c98c40d769fc5..404de1c00f794747f3ab17c2a63dba69e40f582e 100644 (file)
--- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java
@@ -37,21 +37,24 @@ import javax.annotation.Nonnull;
  * callback on that particular instance. Any transaction which is not submitted by the
  * time the callback returns will be implicitly cancelled. A producer becomes unbound
  * when the listener it is bound to becomes unregistered.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.api.DOMDataTreeProducer} instead.
  */
+@Deprecated
 public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoCloseable {
     /**
      * Allocate a new open transaction on this producer. Any and all transactions
      * previously allocated must have been either submitted or cancelled by the
      * time this method is invoked.
      *
-     * @param barrier Indicates whether this transaction should be a barrier. A barrier
+     * @param isolated Indicates whether this transaction should be a barrier. A barrier
      *                transaction is processed separately from any preceding transactions.
      *                Non-barrier transactions may be merged and processed in a batch,
      *                such that any observers see the modifications contained in them as
      *                if the modifications were made in a single transaction.
      * @return A new {@link DOMDataWriteTransaction}
-     * @throws {@link IllegalStateException} if a previous transaction was not closed.
-     * @throws {@link IllegalThreadStateException} if the calling thread context does not
+     * @throws IllegalStateException if a previous transaction was not closed.
+     * @throws IllegalThreadStateException if the calling thread context does not
      *         match the lifecycle rules enforced by the producer state (e.g. bound or unbound).
      *         This exception is thrown on a best effort basis and programs should not rely
      *         on it for correct operation.
@@ -73,10 +76,10 @@ public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoClo
      * Once this method returns successfully, this (parent) producer loses the ability to
      * access the specified paths until the resulting (child) producer is shut down.
      *
-     * @throws {@link IllegalStateException} if there is an open transaction
-     * @throws {@link IllegalArgumentException} if subtrees contains a subtree which is not
+     * @throws IllegalStateException if there is an open transaction
+     * @throws IllegalArgumentException if subtrees contains a subtree which is not
      *         accessible by this producer
-     * @throws {@link IllegalThreadStateException} if the calling thread context does not
+     * @throws IllegalThreadStateException if the calling thread context does not
      *         match the lifecycle rules enforced by the producer state (e.g. bound or unbound).
      *         This exception is thrown on a best effort basis and programs should not rely
      *         on it for correct operation.