X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=dom%2Fmdsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fdom%2Fapi%2FDOMDataTreeWriteTransaction.java;h=9c06d7d589a1f2e23ba73bcb0c9e4a5383c3ab64;hb=a097ce084ca81e5b2f2ccbf15cf37e29511083f5;hp=31f16280e15af95e1c7b132b8bb9f154deb55655;hpb=ab5f1103fd61e62f21aa751f550f013c5ff40a3b;p=mdsal.git diff --git a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteTransaction.java b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteTransaction.java index 31f16280e1..9c06d7d589 100644 --- a/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteTransaction.java +++ b/dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteTransaction.java @@ -8,7 +8,7 @@ package org.opendaylight.mdsal.dom.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; @@ -107,7 +107,7 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM * 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();
@@ -135,7 +135,7 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM
      * doWrite(2);
      * 
* - *

Failure scenarios

+ *

Failure scenarios

* *

* Transaction may fail because of multiple reasons, such as @@ -158,7 +158,7 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM * * * - *

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. * @@ -166,7 +166,8 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM * 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. * - * + *
+ * * * * @@ -243,7 +244,8 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM * 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
+ *
+ * * * * @@ -403,9 +405,9 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM *
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. * @@ -445,8 +447,8 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM * 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(); }