Add a few 3.0.0 FIXMEs

[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / tree / DataTreeTip.java

diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/DataTreeTip.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/DataTreeTip.java
index 8f23488474a79e81c6542a8171a3ba30975352b6..77c3142c5f7cf11b0bda5386c5a9bc075eaf84f6 100644 (file)
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/DataTreeTip.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/DataTreeTip.java
@@ -10,27 +10,30 @@ package org.opendaylight.yangtools.yang.data.api.schema.tree;
 import com.google.common.annotations.Beta;
 
 /**
- * Tip of a data tree instance. It acts as a point to which modifications can
- * be applied.
+ * Tip of a data tree instance. It acts as a point to which modifications can be applied.
  */
+// FIXME: 3.0.0: Use @NonNullByDefault
 @Beta
 public interface DataTreeTip {
     /**
      * Validate whether a particular modification can be applied to the data tree.
-     * @param modification
-     *                  Data tree modification.
-     * @throws DataValidationFailedException
-     *                  If modification data is not valid.
+     *
+     * @param modification Data tree modification.
+     * @throws DataValidationFailedException If modification data is not valid.
      */
+    // FIXME: 3.0.0: document NullPointerException being thrown
+    // FIXME: 3.0.0: document IllegalArgumentException being thrown
     void validate(DataTreeModification modification) throws DataValidationFailedException;
 
     /**
      * Prepare a modification for commit.
      *
-     * @param modification
-     *                  Data tree modification.
+     * @param modification Data tree modification.
      * @return candidate data tree
      */
+    // FIXME: 3.0.0: document NullPointerException being thrown
+    // FIXME: 3.0.0: document IllegalArgumentException being thrown
+    // FIXME: 3.0.0: throw DataValidationFailedException or similar
     DataTreeCandidateTip prepare(DataTreeModification modification);
 
     /**