Eliminate ConstraintDefition.isMandatory()
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / tree / ModifiedNode.java
index 653bf82635d9f1ef8f9722c718ed8a1a1d606417..5456380cc51609730143f0496b65824a9b8ee122 100644 (file)
@@ -7,11 +7,12 @@
  */
 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
 
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Predicate;
+import static java.util.Objects.requireNonNull;
+
 import java.util.Collection;
 import java.util.Map;
+import java.util.Optional;
+import java.util.function.Predicate;
 import javax.annotation.Nonnull;
 import javax.annotation.concurrent.NotThreadSafe;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
@@ -24,12 +25,14 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
 
 /**
- * Node Modification Node and Tree
+ * Node Modification Node and Tree.
  *
+ * <p>
  * Tree which structurally resembles data tree and captures client modifications to the data store tree. This tree is
  * lazily created and populated via {@link #modifyChild(PathArgument, ModificationApplyOperation, Version)} and
  * {@link TreeNode} which represents original state as tracked by {@link #getOriginal()}.
  *
+ * <p>
  * The contract is that the state information exposed here preserves the temporal ordering of whatever modifications
  * were executed. A child's effects pertain to data node as modified by its ancestors. This means that in order to
  * reconstruct the effective data node presentation, it is sufficient to perform a depth-first pre-order traversal of
@@ -38,7 +41,7 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
 @NotThreadSafe
 final class ModifiedNode extends NodeModification implements StoreTreeNode<ModifiedNode> {
     static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = input -> {
-        Preconditions.checkNotNull(input);
+        requireNonNull(input);
         switch (input.getOperation()) {
             case DELETE:
             case MERGE:
@@ -47,9 +50,9 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
             case TOUCH:
             case NONE:
                 return false;
+            default:
+                throw new IllegalArgumentException("Unhandled modification type " + input.getOperation());
         }
-
-        throw new IllegalArgumentException(String.format("Unhandled modification type %s", input.getOperation()));
     };
 
     private final Map<PathArgument, ModifiedNode> children;
@@ -68,7 +71,8 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     private Optional<TreeNode> validatedCurrent;
     private TreeNode validatedNode;
 
-    private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original, final ChildTrackingPolicy childPolicy) {
+    private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original,
+            final ChildTrackingPolicy childPolicy) {
         this.identifier = identifier;
         this.original = original;
         this.children = childPolicy.createMap();
@@ -102,20 +106,17 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     }
 
     /**
+     * Returns child modification if child was modified.
      *
-     * Returns child modification if child was modified
-     *
-     * @return Child modification if direct child or it's subtree
-     *  was modified.
-     *
+     * @return Child modification if direct child or it's subtree was modified.
      */
     @Override
     public Optional<ModifiedNode> getChild(final PathArgument child) {
-        return Optional.fromNullable(children.get(child));
+        return Optional.ofNullable(children.get(child));
     }
 
     private Optional<TreeNode> metadataFromSnapshot(@Nonnull final PathArgument child) {
-        return original.isPresent() ? original.get().getChild(child) : Optional.absent();
+        return original.isPresent() ? original.get().getChild(child) : Optional.empty();
     }
 
     private Optional<TreeNode> metadataFromData(@Nonnull final PathArgument child, final Version modVersion) {
@@ -140,28 +141,25 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      */
     private Optional<TreeNode> findOriginalMetadata(@Nonnull final PathArgument child, final Version modVersion) {
         switch (operation) {
-        case DELETE:
-            // DELETE implies non-presence
-            return Optional.absent();
-        case NONE:
-        case TOUCH:
-        case MERGE:
-            return metadataFromSnapshot(child);
-        case WRITE:
-            // WRITE implies presence based on written data
-            return metadataFromData(child, modVersion);
+            case DELETE:
+                // DELETE implies non-presence
+                return Optional.empty();
+            case NONE:
+            case TOUCH:
+            case MERGE:
+                return metadataFromSnapshot(child);
+            case WRITE:
+                // WRITE implies presence based on written data
+                return metadataFromData(child, modVersion);
+            default:
+                throw new IllegalStateException("Unhandled node operation " + operation);
         }
-
-        throw new IllegalStateException("Unhandled node operation " + operation);
     }
 
     /**
-     *
      * Returns child modification if child was modified, creates {@link ModifiedNode}
-     * for child otherwise.
-     *
-     * If this node's {@link ModificationType} is {@link ModificationType#UNMODIFIED}
-     * changes modification type to {@link ModificationType#SUBTREE_MODIFIED}
+     * for child otherwise. If this node's {@link ModificationType} is {@link ModificationType#UNMODIFIED}
+     * changes modification type to {@link ModificationType#SUBTREE_MODIFIED}.
      *
      * @param child child identifier, may not be null
      * @param childOper Child operation
@@ -201,7 +199,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     }
 
     /**
-     * Returns all recorded direct child modification
+     * Returns all recorded direct child modifications.
      *
      * @return all recorded direct child modifications
      */
@@ -217,31 +215,29 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
         final LogicalOperation newType;
 
         switch (operation) {
-        case DELETE:
-        case NONE:
-            // We need to record this delete.
-            newType = LogicalOperation.DELETE;
-            break;
-        case MERGE:
-                // In case of merge - delete needs to be recored and must not to be changed into
-                // NONE, because lazy expansion of parent MERGE node would reintroduce it
-                // again.
+            case DELETE:
+            case NONE:
+                // We need to record this delete.
                 newType = LogicalOperation.DELETE;
                 break;
-        case TOUCH:
-        case WRITE:
-            /*
-             * We are canceling a previous modification. This is a bit tricky,
-             * as the original write may have just introduced the data, or it
-             * may have modified it.
-             *
-             * As documented in BUG-2470, a delete of data introduced in this
-             * transaction needs to be turned into a no-op.
-             */
-            newType = original.isPresent() ? LogicalOperation.DELETE : LogicalOperation.NONE;
-            break;
-        default:
-            throw new IllegalStateException("Unhandled deletion of node with " + operation);
+            case MERGE:
+                // In case of merge - delete needs to be recored and must not to be changed into NONE, because lazy
+                // expansion of parent MERGE node would reintroduce it again.
+                newType = LogicalOperation.DELETE;
+                break;
+            case TOUCH:
+            case WRITE:
+                /*
+                 * We are canceling a previous modification. This is a bit tricky, as the original write may have just
+                 * introduced the data, or it may have modified it.
+                 *
+                 * As documented in BUG-2470, a delete of data introduced in this transaction needs to be turned into
+                 * a no-op.
+                 */
+                newType = original.isPresent() ? LogicalOperation.DELETE : LogicalOperation.NONE;
+                break;
+            default:
+                throw new IllegalStateException("Unhandled deletion of node with " + operation);
         }
 
         clearSnapshot();
@@ -253,7 +249,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     /**
      * Records a write for associated node.
      *
-     * @param value
+     * @param value new value
      */
     void write(final NormalizedNode<?, ?> value) {
         updateValue(LogicalOperation.WRITE, value);
@@ -263,7 +259,8 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     /**
      * Seal the modification node and prune any children which has not been modified.
      *
-     * @param schema
+     * @param schema associated apply operation
+     * @param version target version
      */
     void seal(final ModificationApplyOperation schema, final Version version) {
         clearSnapshot();
@@ -275,7 +272,6 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
                 if (children.isEmpty()) {
                     updateOperationType(LogicalOperation.NONE);
                 }
-
                 break;
             case WRITE:
                 // A WRITE can collapse all of its children
@@ -286,21 +282,6 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
 
                 schema.verifyStructure(value, true);
                 break;
-            /*
-             * Perform full validation in case of merge operation. This validation is performed during sealing of
-             * a ModifiedNode when we run InMemoryDataTreeModification.ready() just as it is in case of write operation
-             * above.
-             *
-             * Some parts of this validation may also be re-done during InMemoryDataTree.prepare() in case when we
-             * merge or write a MapEntry directly (e.g. Bug5968MergeTest.mergeValidMapEntryTest()), however in other
-             * cases full validation is performed only once just here.
-             */
-            case MERGE:
-                final Optional<TreeNode> result = schema.apply(this, getOriginal(), version);
-                if (result.isPresent()) {
-                    schema.verifyStructure(result.get().getData(), true);
-                }
-                break;
             default:
                 break;
         }
@@ -315,7 +296,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     }
 
     Optional<TreeNode> setSnapshot(final Optional<TreeNode> snapshot) {
-        snapshotCache = Preconditions.checkNotNull(snapshot);
+        snapshotCache = requireNonNull(snapshot);
         return snapshot;
     }
 
@@ -345,7 +326,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      * @param value New node value
      */
     void updateValue(final LogicalOperation type, final NormalizedNode<?, ?> value) {
-        this.value = Preconditions.checkNotNull(value);
+        this.value = requireNonNull(value);
         updateOperationType(type);
     }
 
@@ -366,9 +347,9 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     }
 
     void setValidatedNode(final SchemaAwareApplyOperation op, final Optional<TreeNode> current, final TreeNode node) {
-        this.validatedOp = Preconditions.checkNotNull(op);
-        this.validatedCurrent = Preconditions.checkNotNull(current);
-        this.validatedNode = Preconditions.checkNotNull(node);
+        this.validatedOp = requireNonNull(op);
+        this.validatedCurrent = requireNonNull(current);
+        this.validatedNode = requireNonNull(node);
     }
 
     TreeNode getValidatedNode(final SchemaAwareApplyOperation op, final Optional<TreeNode> current) {