Migrate OSGI compendium reference
[controller.git] / opendaylight / md-sal / sal-dom-spi / src / main / java / org / opendaylight / controller / sal / core / spi / data / DOMStoreTransactionChain.java
index 5876c50d51380a865afead594618627e7347bf3f..1bb700a3909b31b7b86f5fe7a4e327300c9f2af2 100644 (file)
@@ -13,18 +13,21 @@ package org.opendaylight.controller.sal.core.spi.data;
  * as if they happened. A chain makes no guarantees of atomicity, in fact
  * transactions are committed as soon as possible.
  *
- *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain} instead.
  */
+@Deprecated(forRemoval = true)
 public interface DOMStoreTransactionChain extends DOMStoreTransactionFactory, AutoCloseable {
 
     /**
      * Create a new read only transaction which will continue the chain. The
      * previous write transaction has to be either READY or CANCELLED.
      *
+     * <p>
      * If previous write transaction was already commited to data store, new
      * read-only transaction is same as obtained via {@link DOMStore#newReadOnlyTransaction()}
      * and contains merged result of previous one and current state of data store.
      *
+     * <p>
      * Otherwise read-only transaction presents isolated view as if previous read-write
      * transaction was successful. State which was introduced by other transactions
      * outside this transaction chain after creation of previous transaction is not visible.
@@ -35,16 +38,18 @@ public interface DOMStoreTransactionChain extends DOMStoreTransactionFactory, Au
      *             if the chain has been closed.
      */
     @Override
-    public DOMStoreReadTransaction newReadOnlyTransaction();
+    DOMStoreReadTransaction newReadOnlyTransaction();
 
     /**
      * Create a new read write transaction which will continue the chain. The
      * previous read-write transaction has to be either COMMITED or CANCELLED.
      *
+     * <p>
      * If previous write transaction was already commited to data store, new
      * read-write transaction is same as obtained via {@link DOMStore#newReadWriteTransaction()}
      * and contains merged result of previous one and current state of data store.
      *
+     * <p>
      * Otherwise read-write transaction presents isolated view as if previous read-write
      * transaction was successful. State which was introduced by other transactions
      * outside this transaction chain after creation of previous transaction is not visible.
@@ -55,10 +60,10 @@ public interface DOMStoreTransactionChain extends DOMStoreTransactionFactory, Au
      *             if the chain has been closed.
      */
     @Override
-    public DOMStoreReadWriteTransaction newReadWriteTransaction();
+    DOMStoreReadWriteTransaction newReadWriteTransaction();
 
     /**
-     * Create a new read write transaction which will continue the chain. The
+     * Create a new write-only transaction which will continue the chain. The
      * previous read-write transaction has to be either READY or CANCELLED.
      *
      *
@@ -68,18 +73,17 @@ public interface DOMStoreTransactionChain extends DOMStoreTransactionFactory, Au
      *             if the chain has been closed.
      */
     @Override
-    public DOMStoreWriteTransaction newWriteOnlyTransaction();
-
+    DOMStoreWriteTransaction newWriteOnlyTransaction();
 
     /**
      * Closes Transaction Chain.
      *
+     * <p>
      * Close method of transaction chain does not guarantee that
      * last alocated transaction is ready or was submitted.
      *
      * @throws IllegalStateException If any of the outstanding created transactions was not canceled or ready.
      */
     @Override
-    public void close();
-
+    void close();
 }