Reduce list/map/entry strategy confusion
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / tree / SchemaAwareApplyOperation.java
index 56ca5b69a0d7f8802631b218c6a641f4190bc183..ae8440ce84db1ec3d3dfed30a43f38fbe16f9080 100644 (file)
@@ -12,9 +12,12 @@ import static com.google.common.base.Verify.verifyNotNull;
 
 import java.util.List;
 import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.AnydataNode;
+import org.opendaylight.yangtools.yang.data.api.schema.AnyxmlNode;
 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.ConflictingModificationAppliedException;
@@ -24,26 +27,29 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
+import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
+abstract class SchemaAwareApplyOperation<T extends WithStatus> extends ModificationApplyOperation {
     private static final Logger LOG = LoggerFactory.getLogger(SchemaAwareApplyOperation.class);
 
-    public static ModificationApplyOperation from(final DataSchemaNode schemaNode,
-            final DataTreeConfiguration treeConfig) {
-        if (treeConfig.getTreeType() == TreeType.CONFIGURATION) {
-            checkArgument(schemaNode.isConfiguration(), "Supplied %s does not belongs to configuration tree.",
-                schemaNode.getPath());
+    static ModificationApplyOperation from(final DataSchemaNode schemaNode,
+            final DataTreeConfiguration treeConfig) throws ExcludedDataSchemaNodeException {
+        if (!belongsToTree(treeConfig.getTreeType(), schemaNode)) {
+            throw new ExcludedDataSchemaNodeException(schemaNode + " does not belong to configuration tree");
         }
         if (schemaNode instanceof ContainerSchemaNode) {
             return ContainerModificationStrategy.of((ContainerSchemaNode) schemaNode, treeConfig);
@@ -52,14 +58,22 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
         } else if (schemaNode instanceof ChoiceSchemaNode) {
             return new ChoiceModificationStrategy((ChoiceSchemaNode) schemaNode, treeConfig);
         } else if (schemaNode instanceof LeafListSchemaNode) {
-            return fromLeafListSchemaNode((LeafListSchemaNode) schemaNode, treeConfig);
+            return MinMaxElementsValidation.from(new LeafSetModificationStrategy((LeafListSchemaNode) schemaNode,
+                treeConfig));
         } else if (schemaNode instanceof LeafSchemaNode) {
             return new ValueNodeModificationStrategy<>(LeafNode.class, (LeafSchemaNode) schemaNode);
+        } else if (schemaNode instanceof AnydataSchemaNode) {
+            return new ValueNodeModificationStrategy<>(AnydataNode.class, (AnydataSchemaNode) schemaNode);
+        } else if (schemaNode instanceof AnyxmlSchemaNode) {
+            return new ValueNodeModificationStrategy<>(AnyxmlNode.class, (AnyxmlSchemaNode) schemaNode);
+        } else if (schemaNode instanceof SchemaContext) {
+            return new StructuralContainerModificationStrategy((SchemaContext) schemaNode, treeConfig);
+        } else {
+            throw new IllegalStateException("Unsupported schema " + schemaNode);
         }
-        throw new IllegalArgumentException("Not supported schema node type for " + schemaNode.getClass());
     }
 
-    public static SchemaAwareApplyOperation from(final DataNodeContainer resolvedTree,
+    static AugmentationModificationStrategy from(final DataNodeContainer resolvedTree,
             final AugmentationTarget augSchemas, final AugmentationIdentifier identifier,
             final DataTreeConfiguration treeConfig) {
         for (final AugmentationSchemaNode potential : augSchemas.getAvailableAugmentations()) {
@@ -83,19 +97,14 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
     private static ModificationApplyOperation fromListSchemaNode(final ListSchemaNode schemaNode,
             final DataTreeConfiguration treeConfig) {
         final List<QName> keyDefinition = schemaNode.getKeyDefinition();
-        final SchemaAwareApplyOperation op;
+        final SchemaAwareApplyOperation<ListSchemaNode> op;
         if (keyDefinition == null || keyDefinition.isEmpty()) {
-            op = new UnkeyedListModificationStrategy(schemaNode, treeConfig);
+            op = new ListModificationStrategy(schemaNode, treeConfig);
         } else {
             op = MapModificationStrategy.of(schemaNode, treeConfig);
         }
 
-        return MinMaxElementsValidation.from(op, schemaNode);
-    }
-
-    private static ModificationApplyOperation fromLeafListSchemaNode(final LeafListSchemaNode schemaNode,
-            final DataTreeConfiguration treeConfig) {
-        return MinMaxElementsValidation.from(new LeafSetModificationStrategy(schemaNode, treeConfig), schemaNode);
+        return MinMaxElementsValidation.from(op);
     }
 
     protected static void checkNotConflicting(final ModificationPath path, final TreeNode original,
@@ -113,8 +122,8 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
     }
 
     @Override
-    void checkApplicable(final ModificationPath path, final NodeModification modification,
-            final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
+    final void checkApplicable(final ModificationPath path, final NodeModification modification,
+            final Optional<? extends TreeNode> current, final Version version) throws DataValidationFailedException {
         switch (modification.getOperation()) {
             case DELETE:
                 checkDeleteApplicable(modification, current);
@@ -165,8 +174,8 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
     }
 
     protected void checkMergeApplicable(final ModificationPath path, final NodeModification modification,
-            final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
-        final Optional<TreeNode> original = modification.getOriginal();
+            final Optional<? extends TreeNode> current, final Version version) throws DataValidationFailedException {
+        final Optional<? extends TreeNode> original = modification.getOriginal();
         if (original.isPresent() && current.isPresent()) {
             /*
              * We need to do conflict detection only and only if the value of leaf changed
@@ -193,8 +202,8 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
      * @throws DataValidationFailedException when a data dependency conflict is detected
      */
     private static void checkWriteApplicable(final ModificationPath path, final NodeModification modification,
-            final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
-        final Optional<TreeNode> original = modification.getOriginal();
+            final Optional<? extends TreeNode> current, final Version version) throws DataValidationFailedException {
+        final Optional<? extends TreeNode> original = modification.getOriginal();
         if (original.isPresent() && current.isPresent()) {
             checkNotConflicting(path, original.get(), current.get());
         } else {
@@ -203,7 +212,8 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
         }
     }
 
-    private static void checkDeleteApplicable(final NodeModification modification, final Optional<TreeNode> current) {
+    private static void checkDeleteApplicable(final NodeModification modification,
+            final Optional<? extends TreeNode> current) {
         // Delete is always applicable, we do not expose it to subclasses
         if (!current.isPresent()) {
             LOG.trace("Delete operation turned to no-op on missing node {}", modification);
@@ -211,7 +221,7 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
     }
 
     @Override
-    Optional<TreeNode> apply(final ModifiedNode modification, final Optional<TreeNode> currentMeta,
+    Optional<? extends TreeNode> apply(final ModifiedNode modification, final Optional<? extends TreeNode> currentMeta,
             final Version version) {
         switch (modification.getOperation()) {
             case DELETE:
@@ -263,7 +273,7 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
     protected abstract TreeNode applyMerge(ModifiedNode modification, TreeNode currentMeta, Version version);
 
     protected abstract TreeNode applyWrite(ModifiedNode modification, NormalizedNode<?, ?> newValue,
-            Optional<TreeNode> currentMeta, Version version);
+            Optional<? extends TreeNode> currentMeta, Version version);
 
     /**
      * Apply a nested operation. Since there may not actually be a nested operation
@@ -288,7 +298,13 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
      *         modification is not applicable (e.g. leaf node).
      */
     protected abstract void checkTouchApplicable(ModificationPath path, NodeModification modification,
-            Optional<TreeNode> current, Version version) throws DataValidationFailedException;
+            Optional<? extends TreeNode> current, Version version) throws DataValidationFailedException;
+
+    /**
+     * Return the {@link WithStatus}-subclass schema associated with this operation.
+     * @return A model node
+     */
+    abstract @NonNull T getSchema();
 
     /**
      * Checks if supplied schema node belong to specified Data Tree type. All nodes belong to the operational tree,
@@ -298,7 +314,7 @@ abstract class SchemaAwareApplyOperation extends ModificationApplyOperation {
      * @param node Schema node
      * @return {@code true} if the node matches the tree type, {@code false} otherwise.
      */
-    static boolean belongsToTree(final TreeType treeType, final DataSchemaNode node) {
+    static final boolean belongsToTree(final TreeType treeType, final DataSchemaNode node) {
         return treeType == TreeType.OPERATIONAL || node.isConfiguration();
     }
 }