Migrate OSGI compendium reference
[controller.git] / opendaylight / md-sal / sal-dom-spi / src / main / java / org / opendaylight / controller / sal / core / spi / data / DOMStoreTransactionFactory.java
index 433d575cd1193661c6fee3bad890a154f7ad2bf1..3ccc5e2e6b051d0386059b25c68648aa942d5d1d 100644 (file)
@@ -16,27 +16,26 @@ package org.opendaylight.controller.sal.core.spi.data;
  * Underlying {@link DOMStore} or {@link DOMStoreTransactionChain}.
  *
  * <p>
- * See {@link DOMStore} or {@link DOMStoreTransactionChain} for concrete
- * variations of this factory.
+ * See DOMStore, DOMStoreTransactionChain for concrete variations of this factory.
  *
  * <p>
  * <b>Note:</b> This interface is used only to define common functionality
  * between {@link DOMStore} and {@link DOMStoreTransactionChain}, which
  * further specify behaviour of returned transactions.
  *
+ * @deprecated Use {@link org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionFactory} instead.
  */
+@Deprecated(forRemoval = true)
 public interface DOMStoreTransactionFactory {
 
     /**
-     *
-     * Creates a read only transaction
+     * Creates a read only transaction.
      *
      * <p>
      * Creates a new read-only transaction, which provides read access to
      * snapshot of current state.
      *
-     * See {@link DOMStoreReadTransaction} for more information.
-     *
+     * @see DOMStoreReadTransaction for more information.
      * @return new {@link DOMStoreReadTransaction}
      * @throws IllegalStateException
      *             If state of factory prevents allocating new transaction.
@@ -45,22 +44,18 @@ public interface DOMStoreTransactionFactory {
     DOMStoreReadTransaction newReadOnlyTransaction();
 
     /**
-     * Creates write only transaction
-     *
-     * <p>
-     * See {@link DOMStoreWriteTransaction} for more information.
+     * Creates write only transaction.
      *
+     * @see DOMStoreWriteTransaction for more information.
      * @return new {@link DOMStoreWriteTransaction}
      * @throws IllegalStateException If state of factory prevents allocating new transaction.
      */
     DOMStoreWriteTransaction newWriteOnlyTransaction();
 
     /**
-     * Creates Read-Write transaction
-     *
-     * <p>
-     * See {@link DOMStoreReadWriteTransaction} for more information.
+     * Creates Read-Write transaction.
      *
+     * @see DOMStoreReadWriteTransaction for more information.
      * @return  new {@link DOMStoreWriteTransaction}
      * @throws IllegalStateException If state of factory prevents allocating new transaction.
      */