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=396ef0042e79c676c05a9e4fe6eb2d41527e3ab8;hp=cedd883b220199116502b47bc034ac1fe98ea5f2;hb=3ec97cd0a86ad1b79f6854dc6924eb7b06e359a3;hpb=e64d758b45360b2ed8b7d8967fc1c7caaa7aa58f 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 cedd883b22..396ef0042e 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.
*
@@ -61,18 +62,19 @@ import org.opendaylight.yangtools.concepts.Path;
* @param , 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.
*
* @return new read-only transaction
*/
- AsyncReadTransaction newReadOnlyTransaction();
+ AsyncReadOnlyTransaction newReadOnlyTransaction();
/**
* Allocates new read-write transaction which provides a mutable view of the data
@@ -82,7 +84,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 +100,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 +108,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.