yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModificationApplyOperation.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
   9
  10 import java.util.Optional;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  12 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  13 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  14 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  16 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  17
  18 /**
  19  * Operation responsible for applying {@link ModifiedNode} on tree.
  20  *
  21  * <p>
  22  * Operation is composite - operation on top level node consists of
  23  * suboperations on child nodes. This allows to walk operation hierarchy and
  24  * invoke suboperations independently.
  25  *
  26  * <p>
  27  * <b>Implementation notes</b>
  28  * <ul>
  29  * <li>
  30  * Implementations MUST expose all nested suboperations which operates on child
  31  * nodes expose via {@link #getChild(PathArgument)} method.
  32  * <li>Same suboperations SHOULD be used when invoked via
  33  * {@link #apply(ModifiedNode, Optional, Version)} if applicable.
  34  * </ul>
  35  *
  36  * <p>
  37  * Hierarchical composite operation which is responsible for applying
  38  * modification on particular subtree and creating updated subtree
  39  */
  40 abstract class ModificationApplyOperation implements StoreTreeNode<ModificationApplyOperation> {
  41     /**
  42      * Implementation of this operation must be stateless and must not change state of this object.
  43      *
  44      * @param modification
  45      *            NodeModification to be applied
  46      * @param storeMeta
  47      *            Store Metadata Node on which NodeModification should be
  48      *            applied
  49      * @param version New subtree version of parent node
  50      * @return new {@link TreeNode} if operation resulted in updating
  51      *         node, {@link Optional#absent()} if {@link ModifiedNode}
  52      *         resulted in deletion of this node.
  53      * @throws IllegalArgumentException
  54      *             If it is not possible to apply Operation on provided Metadata
  55      *             node
  56      */
  57     abstract Optional<? extends TreeNode> apply(ModifiedNode modification, Optional<? extends TreeNode> storeMeta,
  58             Version version);
  59
  60     /**
  61      * Checks if provided node modification could be applied to current metadata node.
  62      *
  63      * @param path Path to modification
  64      * @param modification Modification
  65      * @param current Metadata Node to which modification should be applied
  66      * @param version Metadata version
  67      * @throws DataValidationFailedException if the modification is not applicable
  68      */
  69     abstract void checkApplicable(ModificationPath path, NodeModification modification,
  70             Optional<? extends TreeNode> current, Version version) throws DataValidationFailedException;
  71
  72     /**
  73      * Performs a quick structural verification of NodeModification, such as written values / types uses right
  74      * structural elements.
  75      *
  76      * @param modification data to be verified.
  77      * @throws IllegalArgumentException If provided NodeModification does not adhere to the
  78      *         structure.
  79      */
  80     abstract void quickVerifyStructure(NormalizedNode<?, ?> modification);
  81
  82     /**
  83      * Performs a full structural verification of NodeModification, such as written values / types uses right
  84      * structural elements. Unlike {@link #quickVerifyStructure(NormalizedNode)} this includes recursively checking
  85      * children, too.
  86      *
  87      * @param modification data to be verified.
  88      * @throws IllegalArgumentException If provided NodeModification does not adhere to the
  89      *         structure.
  90      */
  91     abstract void fullVerifyStructure(NormalizedNode<?, ?> modification);
  92
  93     /**
  94      * Return the tracking policy for this node's children.
  95      *
  96      * @return Tracking policy, may not be null.
  97      */
  98     abstract ChildTrackingPolicy getChildPolicy();
  99
 100     /**
 101      * Stage a merge operation into a {@link ModifiedNode} such that it will be processed correctly by
 102      * {@link #apply(ModifiedNode, Optional, Version)}. This method is the context which is introducing this operation,
 103      * and so any overheads are charged to whoever is in control of the access pattern.
 104      *
 105      * @param modification Original modification node
 106      * @param value Value which should be merge into the modification
 107      * @param version Data version as carried in the containing {@link InMemoryDataTreeModification}
 108      */
 109     abstract void mergeIntoModifiedNode(ModifiedNode modification, NormalizedNode<?, ?> value, Version version);
 110
 111     /**
 112      * Returns a suboperation for specified tree node.
 113      *
 114      * @return Reference to suboperation for specified tree node, {@link Optional#empty()}
 115      *         if suboperation is not supported for specified tree node.
 116      */
 117     @Override
 118     public abstract Optional<ModificationApplyOperation> getChild(PathArgument child);
 119
 120     abstract void recursivelyVerifyStructure(NormalizedNode<?, ?> value);
 121 }