Deprecate all MD-SAL APIs

[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / md / sal / binding / api / WriteTransaction.java

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java
index a6ba2e2799b99f884c119dae6ef67e44bd85a562..1bd5404f709cf47d3986c594650b39f595158ea7 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/WriteTransaction.java
@@ -14,9 +14,13 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
 /**
  * A transaction that provides mutation capabilities on a data tree.
+ *
  * <p>
  * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
+ *
+ * @deprecated Use {@link org.opendaylight.mdsal.binding.api.WriteTransaction} instead.
  */
+@Deprecated
 public interface WriteTransaction extends AsyncWriteTransaction<InstanceIdentifier<?>, DataObject> {
 
     /**
@@ -67,8 +71,9 @@ public interface WriteTransaction extends AsyncWriteTransaction<InstanceIdentifi
      * @param data
      *            the data object to be written to the specified path
      * @param createMissingParents
-     *            if true, any missing parent nodes will be automatically
-     *            created using a merge operation.
+     *            if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing
+     *            parent nodes will be automatically created using a merge
+     *            operation.
      * @throws IllegalStateException
      *             if the transaction has already been submitted
      */
@@ -115,8 +120,9 @@ public interface WriteTransaction extends AsyncWriteTransaction<InstanceIdentifi
      * @param data
      *            the data object to be merged to the specified path
      * @param createMissingParents
-     *            if true, any missing parent nodes will be automatically created
-     *            using a merge operation.
+     *            if {@link #CREATE_MISSING_PARENTS} ({@code true}), any missing
+     *            parent nodes will be automatically created using a merge
+     *            operation.
      * @throws IllegalStateException
      *             if the transaction has already been submitted
      */
@@ -125,4 +131,14 @@ public interface WriteTransaction extends AsyncWriteTransaction<InstanceIdentifi
 
     @Override
     void delete(LogicalDatastoreType store, InstanceIdentifier<?> path);
+
+    /**
+     * Flag value indicating that missing parents should be created.
+     */
+    boolean CREATE_MISSING_PARENTS = true;
+
+    /**
+     * Flag value indicating that missing parents should cause an error.
+     */
+    boolean FAIL_ON_MISSING_PARENTS = false;
 }