X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-data-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fdata%2Fimpl%2Fschema%2Ftree%2FModificationApplyOperation.java;h=9b402a64d79a5296ffdcfa2e0bf48327545d6065;hb=bf009ab944ceb87cbd348ee5b1e23eaefe2577da;hp=f2e13ce216350388fd81488135e488ddd3f3463d;hpb=7ddfd9a64ec0eac11bdd0c4bf60731dcc1970792;p=yangtools.git diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModificationApplyOperation.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModificationApplyOperation.java index f2e13ce216..9b402a64d7 100644 --- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModificationApplyOperation.java +++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModificationApplyOperation.java @@ -7,42 +7,41 @@ */ 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. * + *

* Operation is composite - operation on top level node consists of * suboperations on child nodes. This allows to walk operation hierarchy and * invoke suboperations independently. * + *

* Implementation notes *

* + *

* Hierarchical composite operation which is responsible for applying * modification on particular subtree and creating updated subtree - * - * */ -interface ModificationApplyOperation extends StoreTreeNode { - +abstract class ModificationApplyOperation implements StoreTreeNode { /** - * - * 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 @@ -50,43 +49,82 @@ interface ModificationApplyOperation extends StoreTreeNode apply(ModifiedNode modification, Optional storeMeta, Version version); + abstract Optional apply(ModifiedNode modification, Optional 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 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 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 current) throws DataValidationFailedException; + @Override + public abstract Optional getChild(PathArgument child); + + abstract void recursivelyVerifyStructure(NormalizedNode value); + + abstract ToStringHelper addToStringAttributes(ToStringHelper helper); + + @Override + public final String toString() { + return addToStringAttributes(MoreObjects.toStringHelper(this)).toString(); + } }