X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-common-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fcommon%2Fapi%2Fdata%2FAsyncDataTransactionFactory.java;h=46f6ccc32f2d6fd6b0210728555ba04a59cc1a73;hp=a558b96b2d56fa26658741d8ee11ac63f3e735a3;hb=99f994b3e45963f6ef46bc2b71ab4dd8eea8b9ac;hpb=3ce420ccd45e7530c2c2158bd57462fd5859a879 diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataTransactionFactory.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataTransactionFactory.java index a558b96b2d..46f6ccc32f 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataTransactionFactory.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataTransactionFactory.java @@ -39,7 +39,7 @@ import org.opendaylight.yangtools.concepts.Path; * For a detailed explanation of how transaction are isolated and how transaction-local * changes are committed to global data tree, see * {@link AsyncReadTransaction}, {@link AsyncWriteTransaction}, - * {@link AsyncReadWriteTransaction} and {@link AsyncWriteTransaction#commit()}. + * {@link AsyncReadWriteTransaction} and {@link AsyncWriteTransaction#submit()}. * *

* It is strongly recommended to use the type of transaction, which @@ -48,7 +48,8 @@ import org.opendaylight.yangtools.concepts.Path; * implementations may optimize the transaction for reading if they know ahead * of time that you only need to read data - such as not keeping additional meta-data, * which may be required for write transactions. - *

+ * + *

* Implementation Note: This interface is not intended to be implemented * by users of MD-SAL, but only to be consumed by them. * @@ -64,9 +65,9 @@ import org.opendaylight.yangtools.concepts.Path; public interface AsyncDataTransactionFactory

, D> { /** - * Allocates a new read-only transaction which provides an immutable snapshot of - * the data tree. - *

+ * Allocates a new read-only transaction which provides an immutable snapshot of the data tree. + * + *

* The view of data tree is an immutable snapshot of current data tree state when * transaction was allocated. * @@ -82,7 +83,7 @@ public interface AsyncDataTransactionFactory

, D> { * Preconditions for mutation of data tree are captured from the snapshot of * data tree state, when the transaction is allocated. If data was * changed during transaction in an incompatible way then the commit of this transaction - * will fail. See {@link AsyncWriteTransaction#commit()} for more + * will fail. See {@link AsyncWriteTransaction#submit()} for more * details about conflicting and not-conflicting changes and * failure scenarios. * @@ -98,7 +99,7 @@ public interface AsyncDataTransactionFactory

, D> { * Preconditions for mutation of data tree are captured from the snapshot of * data tree state, when the transaction is allocated. If data was * changed during transaction in an incompatible way then the commit of this transaction - * will fail. See {@link AsyncWriteTransaction#commit()} for more + * will fail. See {@link AsyncWriteTransaction#submit()} for more * details about conflicting and not-conflicting changes and * failure scenarios. * @@ -106,7 +107,8 @@ public interface AsyncDataTransactionFactory

, D> { * Since this transaction does not provide a view of the data it SHOULD BE * used only by callers which are exclusive writers (exporters of data) * to the subtree they modify. This prevents optimistic - * lock failures as described in {@link AsyncWriteTransaction#commit()}. + * lock failures as described in {@link AsyncWriteTransaction#submit()}. + * *

* Exclusivity of writers to particular subtree SHOULD BE enforced by * external locking mechanism.