Fix checkstyle violations in sal-dom-api

[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..1a91a0af9f203b7e7af801684c7d04e94b01dd28 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
@@ -16,42 +16,50 @@ import javax.annotation.Nonnull;
  * open. It needs to be either submitted or cancelled before another one can be open.
  * Once a transaction is submitted, it will proceed to be committed asynchronously.
  *
+ * <p>
  * Each instance has  an upper bound on the number of transactions which can be in-flight,
  * once that capacity is exceeded, an attempt to create a new transaction will block
  * until some transactions complete.
  *
+ * <p>
  * Each {@link DOMDataTreeProducer} can be in two logical states, bound and unbound,
  * which define the lifecycle rules for when is it legal to create and submit transactions
  * in relationship with {@link DOMDataTreeListener} callbacks.
  *
+ * <p>
  * When a producer is first created, it is unbound. In this state the producer can be
  * accessed by any application thread to allocate or submit transactions, as long as
  * the 'single open transaction' rule is maintained. The producer and any transaction
  * object MUST NOT be accessed, directly or indirectly, from a {@link DOMDataTreeListener}
  * callback.
  *
- * When a producer is referenced in a call to {@link DOMDataTreeService#registerListener(DOMDataTreeListener, java.util.Collection, boolean, java.util.Collection)},
+ * <p>
+ * When a producer is referenced in a call to {@link DOMDataTreeService#registerListener(DOMDataTreeListener,
+ * java.util.Collection, boolean, java.util.Collection)},
  * an attempt will be made to bind the producer to the specified {@link DOMDataTreeListener}.
  * Such an attempt will fail the producer is already bound, or it has an open transaction.
  * Once bound, the producer can only be accessed from within the {@link DOMDataTreeListener}
  * 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.
@@ -61,22 +69,25 @@ public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoClo
     /**
      * {@inheritDoc}
      *
+     * <p>
      * When invoked on a {@link DOMDataTreeProducer}, this method has additional restrictions.
      * There may not be an open transaction from this producer. The method needs to be
      * invoked in appropriate context, e.g. bound or unbound.
      *
+     * <p>
      * Specified subtrees must be accessible by this producer. Accessible means they are a subset
      * of the subtrees specified when the producer is instantiated. The set is further reduced as
      * child producers are instantiated -- if you create a producer for /a and then a child for
      * /a/b, /a/b is not accessible from the first producer.
      *
+     * <p>
      * 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.