Deprecate all MD-SAL APIs

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

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadWriteTransaction.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadWriteTransaction.java
index 34101366c806fe56884622ed3118e7d35090228c..4b0e7d600494dae52cc9a29ec96742a2f22c8e9a 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadWriteTransaction.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadWriteTransaction.java
@@ -24,14 +24,14 @@ import org.opendaylight.yangtools.concepts.Path;
  * transactions.
  *
  * <p>
- * Applications publish the changes proposed in the transaction by calling {@link #commit}
+ * Applications publish the changes proposed in the transaction by calling {@link #submit}
  * on the transaction. This seals the transaction
  * (preventing any further writes using this transaction) and submits it to be
  * processed and applied to global conceptual data tree.
  *
  * <p>
  * The transaction commit may fail due to a concurrent transaction modifying and committing data in
- * an incompatible way. See {@link #commit()} for more concrete commit failure examples.
+ * an incompatible way. See {@link #submit()} for more concrete commit failure examples.
  *
  * <b>Implementation Note:</b> This interface is not intended to be implemented
  * by users of MD-SAL, but only to be consumed by them.
@@ -40,6 +40,7 @@ import org.opendaylight.yangtools.concepts.Path;
  *
  * <h3>Transaction local state</h3>
  *
+ * <p>
  * Let assume initial state of data tree for <code>PATH</code> is <code>A</code>
  * .
  *
@@ -56,6 +57,7 @@ import org.opendaylight.yangtools.concepts.Path;
  * tx1afterCommit.read(OPERATIONAL,PATH).get(); // returns Optional containing B
  * </pre>
  *
+ * <p>
  * As you could see read-write transaction provides capabilities as
  * {@link AsyncWriteTransaction} but also allows for reading proposed changes as
  * if they already happened.
@@ -119,11 +121,13 @@ import org.opendaylight.yangtools.concepts.Path;
  * <b>Note:</b> examples contains blocking calls on future only to illustrate
  * that action happened after other asynchronous action. Use of blocking call
  * {@link com.google.common.util.concurrent.ListenableFuture#get()} is discouraged for most uses and you should
- * use
- * {@link com.google.common.util.concurrent.Futures#addCallback(com.google.common.util.concurrent.ListenableFuture, com.google.common.util.concurrent.FutureCallback)}
+ * use {@link com.google.common.util.concurrent.Futures#addCallback(com.google.common.util.concurrent.ListenableFuture,
+ * com.google.common.util.concurrent.FutureCallback, java.util.concurrent.Executor)}
  * or other functions from {@link com.google.common.util.concurrent.Futures} to
  * register more specific listeners.
  *
+ * @see AsyncReadTransaction
+ * @see AsyncWriteTransaction
  *
  * @param <P>
  *            Type of path (subtree identifier), which represents location in
@@ -131,6 +135,7 @@ import org.opendaylight.yangtools.concepts.Path;
  * @param <D>
  *            Type of data (payload), which represents data payload
  */
+@Deprecated
 public interface AsyncReadWriteTransaction<P extends Path<P>, D> extends AsyncReadTransaction<P, D>,
         AsyncWriteTransaction<P, D> {