*/
package org.opendaylight.yangtools.yang.data.impl.schema.tree;
-import com.google.common.base.Optional;
-import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
+import com.google.common.base.MoreObjects;
+import com.google.common.base.MoreObjects.ToStringHelper;
+import java.util.Optional;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
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.data.api.schema.tree.DataValidationFailedException;
/**
- *
* Operation responsible for applying {@link ModifiedNode} on tree.
*
+ * <p>
* Operation is composite - operation on top level node consists of
* suboperations on child nodes. This allows to walk operation hierarchy and
* invoke suboperations independently.
*
+ * <p>
* <b>Implementation notes</b>
* <ul>
* <li>
* Implementations MUST expose all nested suboperations which operates on child
* nodes expose via {@link #getChild(PathArgument)} method.
* <li>Same suboperations SHOULD be used when invoked via
- * {@link #apply(ModifiedNode, Optional)} if applicable.
- *
+ * {@link #apply(ModifiedNode, Optional, Version)} if applicable.
+ * </ul>
*
+ * <p>
* Hierarchical composite operation which is responsible for applying
* modification on particular subtree and creating updated subtree
- *
- *
*/
-interface ModificationApplyOperation extends StoreTreeNode<ModificationApplyOperation> {
-
+abstract class ModificationApplyOperation implements StoreTreeNode<ModificationApplyOperation> {
/**
- *
- * Implementation of this operation must be stateless and must not change
- * state of this object.
+ * Implementation of this operation must be stateless and must not change state of this object.
*
* @param modification
* NodeModification to be applied
* Store Metadata Node on which NodeModification should be
* applied
* @param version New subtree version of parent node
+ * @return new {@link TreeNode} if operation resulted in updating
+ * node, {@link Optional#absent()} if {@link ModifiedNode}
+ * resulted in deletion of this node.
* @throws IllegalArgumentException
* If it is not possible to apply Operation on provided Metadata
* node
- * @return new {@link StoreMetadataNode} if operation resulted in updating
- * node, {@link Optional#absent()} if {@link ModifiedNode}
- * resulted in deletion of this node.
*/
- Optional<TreeNode> apply(ModifiedNode modification, Optional<TreeNode> storeMeta, Version version);
+ abstract Optional<? extends TreeNode> apply(ModifiedNode modification, Optional<? extends TreeNode> storeMeta,
+ Version version);
+
+ /**
+ * Checks if provided node modification could be applied to current metadata node.
+ *
+ * @param path Path to modification
+ * @param modification Modification
+ * @param current Metadata Node to which modification should be applied
+ * @param version Metadata version
+ * @throws DataValidationFailedException if the modification is not applicable
+ */
+ abstract void checkApplicable(ModificationPath path, NodeModification modification,
+ Optional<? extends TreeNode> current, Version version) throws DataValidationFailedException;
/**
+ * Performs a quick structural verification of NodeModification, such as written values / types uses right
+ * structural elements.
*
- * Performs structural verification of NodeModification, such as writen values / types
- * uses right structural elements.
+ * @param modification data to be verified.
+ * @throws IllegalArgumentException If provided NodeModification does not adhere to the
+ * structure.
+ */
+ abstract void quickVerifyStructure(NormalizedNode<?, ?> modification);
+
+ /**
+ * Performs a full structural verification of NodeModification, such as written values / types uses right
+ * structural elements. Unlike {@link #quickVerifyStructure(NormalizedNode)} this includes recursively checking
+ * children, too.
*
- * @param modification to be verified.
- * @throws IllegalArgumentException If provided NodeModification does not adhere to the structure.
+ * @param modification data to be verified.
+ * @throws IllegalArgumentException If provided NodeModification does not adhere to the
+ * structure.
*/
- void verifyStructure(ModifiedNode modification) throws IllegalArgumentException;
+ abstract void fullVerifyStructure(NormalizedNode<?, ?> modification);
/**
- * Returns a suboperation for specified tree node
+ * Return the tracking policy for this node's children.
*
- * @return Reference to suboperation for specified tree node, {@link Optional#absent()}
- * if suboperation is not supported for specified tree node.
+ * @return Tracking policy, may not be null.
*/
- @Override
- Optional<ModificationApplyOperation> getChild(PathArgument child);
+ abstract ChildTrackingPolicy getChildPolicy();
/**
+ * Stage a merge operation into a {@link ModifiedNode} such that it will be processed correctly by
+ * {@link #apply(ModifiedNode, Optional, Version)}. This method is the context which is introducing this operation,
+ * and so any overheads are charged to whoever is in control of the access pattern.
*
- * Checks if provided node modification could be applied to current metadata node.
+ * @param modification Original modification node
+ * @param value Value which should be merge into the modification
+ * @param version Data version as carried in the containing {@link InMemoryDataTreeModification}
+ */
+ abstract void mergeIntoModifiedNode(ModifiedNode modification, NormalizedNode<?, ?> value, Version version);
+
+ /**
+ * Returns a suboperation for specified tree node.
*
- * @param modification Modification
- * @param current Metadata Node to which modification should be applied
- * @return true if modification is applicable
- * false if modification is no applicable
- * @throws DataValidationFailedException
+ * @return Reference to suboperation for specified tree node, {@link Optional#empty()}
+ * if suboperation is not supported for specified tree node.
*/
- void checkApplicable(InstanceIdentifier path, NodeModification modification, Optional<TreeNode> current) throws DataValidationFailedException;
+ @Override
+ public abstract Optional<ModificationApplyOperation> getChild(PathArgument child);
+
+ abstract void recursivelyVerifyStructure(NormalizedNode<?, ?> value);
+
+ abstract ToStringHelper addToStringAttributes(ToStringHelper helper);
+
+ @Override
+ public final String toString() {
+ return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
+ }
}
Code Review / yangtools.git / blobdiff