X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fmdsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fbinding%2Fapi%2FWriteTransaction.java;h=89be6fbb6e3f2622c16f2894077fbe11443122e7;hb=a097ce084ca81e5b2f2ccbf15cf37e29511083f5;hp=7095cfde44f3a9e53821b442c6137288c4f5912f;hpb=d542571c65b06f4142e59b0507d535e906609530;p=mdsal.git diff --git a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/WriteTransaction.java b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/WriteTransaction.java index 7095cfde44..89be6fbb6e 100644 --- a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/WriteTransaction.java +++ b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/WriteTransaction.java @@ -8,7 +8,7 @@ package org.opendaylight.mdsal.binding.api; import com.google.common.util.concurrent.FluentFuture; -import javax.annotation.CheckReturnValue; +import edu.umd.cs.findbugs.annotations.CheckReturnValue; import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.mdsal.common.api.CommitInfo; import org.opendaylight.mdsal.common.api.DataValidationFailedException; @@ -89,8 +89,8 @@ public interface WriteTransaction extends Transaction, WriteOperations { * Invoking cancel() on finished transaction (future returned by {@link #commit()} already successfully completed) * will always fail (return false). * - * @return false if the task could not be cancelled, typically because it has already completed normally; - * true otherwise + * @return {@code false} if the task could not be cancelled, typically because it has already completed normally; + * {@code true} otherwise */ boolean cancel(); @@ -113,7 +113,7 @@ public interface WriteTransaction extends Transaction, WriteOperations { * The effects of a successful commit of data depends on listeners and commit participants that are registered with * the data broker. * - *

Example usage:

+ *

Example usage:

*
      *  private void doWrite(final int tries) {
      *      WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
@@ -141,7 +141,7 @@ public interface WriteTransaction extends Transaction, WriteOperations {
      * doWrite(2);
      * 
* - *

Failure scenarios

+ *

Failure scenarios

* *

* Transaction may fail because of multiple reasons, such as @@ -164,7 +164,7 @@ public interface WriteTransaction extends Transaction, WriteOperations { * * * - *

Change compatibility

+ *

Change compatibility

* There are several sets of changes which could be considered incompatible between two transactions which are * derived from same initial state. Rules for conflict detection applies recursively for each subtree level. * @@ -172,7 +172,8 @@ public interface WriteTransaction extends Transaction, WriteOperations { * Following table shows state changes and failures between two concurrent transactions, which are based on same * initial state, Tx 1 completes successfully before Tx 2 is committed. * - * + *
+ * * * * @@ -249,7 +250,8 @@ public interface WriteTransaction extends Transaction, WriteOperations { * Following table shows state changes and failures between two concurrent transactions, which are based on same * initial state, Tx 1 completes successfully before Tx 2 is committed. * - *
Change compatibility of leaf values
Initial stateTx 1
+ *
+ * * * * @@ -409,9 +411,9 @@ public interface WriteTransaction extends Transaction, WriteOperations { *
Change compatibility of containers
Initial stateTx 1
* * - *

Examples of failure scenarios

+ *

Examples of failure scenarios

* - *

Conflict of two transactions

+ *
Conflict of two transactions
* This example illustrates two concurrent transactions, which derived from same initial state * of data tree and proposes conflicting modifications. *