Split out yang-data-tree-{api,spi}
[yangtools.git] / data / yang-data-tree-api / src / main / java / org / opendaylight / yangtools / yang / data / tree / api / DataTreeModification.java
similarity index 65%
rename from data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/DataTreeModification.java
rename to data/yang-data-tree-api/src/main/java/org/opendaylight/yangtools/yang/data/tree/api/DataTreeModification.java
index 586648cb77eb574e88494883275a1e9d31e64461..8e9e3975804b573ef3fea3494127508d88ab02cd 100644 (file)
@@ -5,16 +5,15 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-package org.opendaylight.yangtools.yang.data.api.schema.tree;
+package org.opendaylight.yangtools.yang.data.tree.api;
 
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 
 /**
- * Class encapsulation of set of modifications to a base tree. This tree is backed
- * by a read-only snapshot and tracks modifications on top of that. The modification
- * has the ability to rebase itself to a new snapshot.
+ * Class encapsulation of set of modifications to a base tree. This tree is backed by a read-only snapshot and tracks
+ * modifications on top of that. The modification has the ability to rebase itself to a new snapshot.
  */
 public interface DataTreeModification extends DataTreeSnapshot {
     /**
@@ -25,8 +24,7 @@ public interface DataTreeModification extends DataTreeSnapshot {
     void delete(YangInstanceIdentifier path);
 
     /**
-     * Merge the specified data with the currently-present data
-     * at specified path.
+     * Merge the specified data with the currently-present data at specified path.
      *
      * @param path Node path
      * @param data Data to be merged
@@ -42,19 +40,16 @@ public interface DataTreeModification extends DataTreeSnapshot {
     void write(YangInstanceIdentifier path, NormalizedNode data);
 
     /**
-     * Finish creation of a modification, making it ready for application
-     * to the data tree. Any calls to this object's methods except
-     * {@link #applyToCursor(DataTreeModificationCursor)} will result
-     * in undefined behavior, possibly with an
-     * {@link IllegalStateException} being thrown.
+     * Finish creation of a modification, making it ready for application to the data tree. Any calls to this object's
+     * methods except {@link #applyToCursor(DataTreeModificationCursor)} will result in undefined behavior, possibly
+     * with an {@link IllegalStateException} being thrown.
      */
     void ready();
 
     /**
-     * Apply the contents of this modification to a cursor. This can be used
-     * to replicate this modification onto another one. The cursor's position
-     * must match the root of this modification, otherwise performing this
-     * operation will result in undefined behavior.
+     * Apply the contents of this modification to a cursor. This can be used to replicate this modification onto another
+     * one. The cursor's position must match the root of this modification, otherwise performing this operation will
+     * result in undefined behavior.
      *
      * @param cursor cursor to which this modification
      */