Rework NormalizedNode type hierarchy
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / tree / ModifiedNode.java
index 31b9089e1fe5a5923c7cc9f6ef9d921bb792a1e1..735418ee59d617dadd21adbe2ad35574a9a25567 100644 (file)
@@ -12,14 +12,16 @@ import static java.util.Objects.requireNonNull;
 
 import com.google.common.base.MoreObjects;
 import com.google.common.base.MoreObjects.ToStringHelper;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.Collection;
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.Predicate;
 import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
@@ -57,11 +59,11 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     };
 
     private final Map<PathArgument, ModifiedNode> children;
-    private final Optional<TreeNode> original;
+    private final Optional<? extends TreeNode> original;
     private final PathArgument identifier;
     private LogicalOperation operation = LogicalOperation.NONE;
     private Optional<TreeNode> snapshotCache;
-    private NormalizedNode<?, ?> value;
+    private NormalizedNode value;
     private ModificationType modType;
 
     // Alternative history introduced in WRITE nodes. Instantiated when we touch any child underneath such a node.
@@ -69,10 +71,10 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
 
     // Internal cache for TreeNodes created as part of validation
     private ModificationApplyOperation validatedOp;
-    private Optional<TreeNode> validatedCurrent;
-    private Optional<TreeNode> validatedNode;
+    private Optional<? extends TreeNode> validatedCurrent;
+    private Optional<? extends TreeNode> validatedNode;
 
-    private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original,
+    private ModifiedNode(final PathArgument identifier, final Optional<? extends TreeNode> original,
             final ChildTrackingPolicy childPolicy) {
         this.identifier = identifier;
         this.original = original;
@@ -90,7 +92,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
     }
 
     @Override
-    Optional<TreeNode> getOriginal() {
+    Optional<? extends TreeNode> getOriginal() {
         return original;
     }
 
@@ -102,7 +104,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      *
      * @return Currently-written value
      */
-    @NonNull NormalizedNode<?, ?> getWrittenValue() {
+    @NonNull NormalizedNode getWrittenValue() {
         return verifyNotNull(value);
     }
 
@@ -112,15 +114,15 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      * @return Child modification if direct child or it's subtree was modified.
      */
     @Override
-    public Optional<ModifiedNode> getChild(final PathArgument child) {
-        return Optional.ofNullable(children.get(child));
+    public ModifiedNode childByArg(final PathArgument arg) {
+        return children.get(arg);
     }
 
-    private Optional<TreeNode> metadataFromSnapshot(final @NonNull PathArgument child) {
-        return original.isPresent() ? original.get().getChild(child) : Optional.empty();
+    private Optional<? extends TreeNode> metadataFromSnapshot(final @NonNull PathArgument child) {
+        return original.isPresent() ? original.get().findChildByArg(child) : Optional.empty();
     }
 
-    private Optional<TreeNode> metadataFromData(final @NonNull PathArgument child, final Version modVersion) {
+    private Optional<? extends TreeNode> metadataFromData(final @NonNull PathArgument child, final Version modVersion) {
         if (writtenOriginal == null) {
             // Lazy instantiation, as we do not want do this for all writes. We are using the modification's version
             // here, as that version is what the SchemaAwareApplyOperation will see when dealing with the resulting
@@ -128,7 +130,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
             writtenOriginal = TreeNodeFactory.createTreeNode(value, modVersion);
         }
 
-        return writtenOriginal.getChild(child);
+        return writtenOriginal.findChildByArg(child);
     }
 
     /**
@@ -140,7 +142,8 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
      * @return Before-image tree node as observed by that child.
      */
-    private Optional<TreeNode> findOriginalMetadata(final @NonNull PathArgument child, final Version modVersion) {
+    private Optional<? extends TreeNode> findOriginalMetadata(final @NonNull PathArgument child,
+            final Version modVersion) {
         switch (operation) {
             case DELETE:
                 // DELETE implies non-presence
@@ -179,9 +182,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
             return potential;
         }
 
-        final Optional<TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
-
-
+        final Optional<? extends TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
         final ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, childOper.getChildPolicy());
         if (operation == LogicalOperation.MERGE && value != null) {
             /*
@@ -189,9 +190,9 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
              * value contains this component, we need to materialize it as a MERGE modification.
              */
             @SuppressWarnings({ "rawtypes", "unchecked" })
-            final Optional<NormalizedNode<?, ?>> childData = ((NormalizedNodeContainer)value).getChild(child);
-            if (childData.isPresent()) {
-                childOper.mergeIntoModifiedNode(newlyCreated, childData.get(), modVersion);
+            final NormalizedNode childData = ((DistinctNodeContainer)value).childByArg(child);
+            if (childData != null) {
+                childOper.mergeIntoModifiedNode(newlyCreated, childData, modVersion);
             }
         }
 
@@ -252,7 +253,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      *
      * @param newValue new value
      */
-    void write(final NormalizedNode<?, ?> newValue) {
+    void write(final NormalizedNode newValue) {
         updateValue(LogicalOperation.WRITE, newValue);
         children.clear();
     }
@@ -335,7 +336,7 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
      * @param type New operation type
      * @param newValue New node value
      */
-    void updateValue(final LogicalOperation type, final NormalizedNode<?, ?> newValue) {
+    void updateValue(final LogicalOperation type, final NormalizedNode newValue) {
         this.value = requireNonNull(newValue);
         updateOperationType(type);
     }
@@ -356,14 +357,26 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
         return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), childPolicy);
     }
 
-    void setValidatedNode(final ModificationApplyOperation op, final Optional<TreeNode> current,
-            final Optional<TreeNode> node) {
+    void setValidatedNode(final ModificationApplyOperation op, final Optional<? extends TreeNode> current,
+            final Optional<? extends TreeNode> node) {
         this.validatedOp = requireNonNull(op);
         this.validatedCurrent = requireNonNull(current);
         this.validatedNode = requireNonNull(node);
     }
 
-    Optional<TreeNode> getValidatedNode(final ModificationApplyOperation op, final Optional<TreeNode> current) {
+    /**
+     * Acquire pre-validated node assuming a previous operation and node. This is a counterpart to
+     * {@link #setValidatedNode(ModificationApplyOperation, Optional, Optional)}.
+     *
+     * @param op Currently-executing operation
+     * @param current Currently-used tree node
+     * @return {@code null} if there is a mismatch with previously-validated node (if present) or the result of previous
+     *         validation.
+     */
+    @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
+            justification = "The contract is package-internal and well documented, we do not need a separate wrapper")
+    @Nullable Optional<? extends TreeNode> getValidatedNode(final ModificationApplyOperation op,
+            final Optional<? extends TreeNode> current) {
         return op.equals(validatedOp) && current.equals(validatedCurrent) ? validatedNode : null;
     }
 }