Add ModifyAction documentation

Adds partial documentation and marks future evolution considerations.

Change-Id: I0eca13d8d9790435c77a3a9d3fd658f0c5cc8c75
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/ModifyAction.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/ModifyAction.java
index bcd73561a724dd47afaad1f4db49f52d280d69a0..aa6fc742c2fab926410f4ea82436f1f9966c3bbe 100644 (file)
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/ModifyAction.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/ModifyAction.java
@@ -9,11 +9,11 @@ package org.opendaylight.yangtools.yang.data.api;
 
 import java.util.Arrays;
 
-// TODO rename to ModifyOperation
-
 /**
- * See https://tools.ietf.org/html/rfc6241#section-7.2.
+ * Edit operation, as defined by <a href="https://tools.ietf.org/html/rfc6241#section-7.2">RFC6241 section 7.2</a>.
  */
+// FIXME: 3.0.0: rename to EditOperation, consider remodeling to take into account MERGE/REPLACE/NONE versus
+//               CREATE/DELETE/REMOVE.
 public enum ModifyAction {
     MERGE(true), REPLACE(true), CREATE(false), DELETE(false), REMOVE(false), NONE(true, false);
 
@@ -49,6 +49,12 @@ public enum ModifyAction {
         this(asDefaultPermitted, true);
     }
 
+    /**
+     * Check if this operation is a candidate for {@code default-operation} argument.
+     *
+     * @return True if this operation can be used as {@code default-operation}.
+     */
+    // FIXME: 3.0.0: consider moving this somewhere else, or renaming it
     public boolean isAsDefaultPermitted() {
         return asDefaultPermitted;
     }