Deprecate all MD-SAL APIs

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

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java
index 852c4e488617a25ef339dc4d58da6d03c4101fad..d51585b826c018f599c773d357b850d98daecded 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java
@@ -11,10 +11,9 @@ import com.google.common.util.concurrent.CheckedFuture;
 import com.google.common.util.concurrent.FluentFuture;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
-import javax.annotation.CheckReturnValue;
 import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.controller.md.sal.common.api.MappingCheckedFuture;
 import org.opendaylight.mdsal.common.api.CommitInfo;
-import org.opendaylight.mdsal.common.api.MappingCheckedFuture;
 import org.opendaylight.yangtools.concepts.Path;
 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
 
@@ -102,6 +101,7 @@ import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
  * @param <D>
  *            Type of data (payload), which represents data payload
  */
+@Deprecated
 public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransaction<P, D> {
     /**
      * Cancels the transaction.
@@ -117,8 +117,8 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * Invoking cancel() on a finished transaction (future returned by {@link #submit()} already completed will always
      * fail (return false).
      *
-     * @return <tt>false</tt> if the task could not be cancelled, typically because it has already completed normally
-     * <tt>true</tt> otherwise
+     * @return {@code false} if the task could not be cancelled, typically because it has already completed normally
+     *         {@code true} otherwise
      *
      */
     boolean cancel();
@@ -229,7 +229,8 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * which are based on same initial state, Tx 1 completes successfully
      * before Tx 2 is submitted.
      *
-     * <table summary="">
+     * <table>
+     * <caption>Data store state changes</caption>
      * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
      * <tr><td>Empty</td><td>put(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, state is A=1</td></tr>
      * <tr><td>Empty</td><td>put(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
@@ -254,7 +255,8 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * which are based on same initial state, Tx 1 completes successfully
      * before Tx 2 is submitted.
      *
-     * <table summary="">
+     * <table>
+     * <caption>Data store state changes</caption>
      * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
      *
      * <tr><td>Empty</td><td>put(TOP,[])</td><td>put(TOP,[])</td><td>Tx 2 will fail, state is TOP=[]</td></tr>
@@ -339,7 +341,6 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * @deprecated Use {@link #commit()} instead.
      */
     @Deprecated
-    @CheckReturnValue
     default CheckedFuture<Void, TransactionCommitFailedException> submit() {
         return MappingCheckedFuture.create(commit().transform(ignored -> null, MoreExecutors.directExecutor()),
                 SUBMIT_EXCEPTION_MAPPER);
@@ -374,7 +375,6 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      *         {@link TransactionCommitFailedException} or an exception derived from TransactionCommitFailedException.
      * @throws IllegalStateException if the transaction is already committed or was canceled.
      */
-    @CheckReturnValue
     @NonNull FluentFuture<? extends @NonNull CommitInfo> commit();
 
     /**
@@ -384,7 +384,7 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
     ExceptionMapper<TransactionCommitFailedException> SUBMIT_EXCEPTION_MAPPER =
         new ExceptionMapper<TransactionCommitFailedException>("submit", TransactionCommitFailedException.class) {
             @Override
-            protected TransactionCommitFailedException newWithCause(String message, Throwable cause) {
+            protected TransactionCommitFailedException newWithCause(final String message, final Throwable cause) {
                 return new TransactionCommitFailedException(message, cause);
             }
         };