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 com.google.common.base.Optional;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  13 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  14 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  15 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
  16 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  17 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  18
  19 /**
  20  * Operation responsible for applying {@link ModifiedNode} on tree.
  21  *
  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  * <b>Implementation notes</b>
  27  * <ul>
  28  * <li>
  29  * Implementations MUST expose all nested suboperations which operates on child
  30  * nodes expose via {@link #getChild(PathArgument)} method.
  31  * <li>Same suboperations SHOULD be used when invoked via
  32  * {@link #apply(ModifiedNode, Optional)} if applicable.
  33  *
  34  *
  35  * Hierarchical composite operation which is responsible for applying
  36  * modification on particular subtree and creating updated subtree
  37  */
  38 abstract class ModificationApplyOperation implements StoreTreeNode<ModificationApplyOperation> {
  39     /**
  40      *
  41      * Implementation of this operation must be stateless and must not change
  42      * 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      * @throws IllegalArgumentException
  51      *             If it is not possible to apply Operation on provided Metadata
  52      *             node
  53      * @return new {@link StoreMetadataNode} if operation resulted in updating
  54      *         node, {@link Optional#absent()} if {@link ModifiedNode}
  55      *         resulted in deletion of this node.
  56      */
  57     abstract Optional<TreeNode> apply(ModifiedNode modification, Optional<TreeNode> storeMeta, Version version);
  58
  59     /**
  60     *
  61     * Checks if provided node modification could be applied to current metadata node.
  62     *
  63     * @param modification Modification
  64     * @param current Metadata Node to which modification should be applied
  65     * @return true if modification is applicable
  66     *         false if modification is no applicable
  67     * @throws DataValidationFailedException
  68     */
  69    abstract void checkApplicable(YangInstanceIdentifier path, NodeModification modification, Optional<TreeNode> current) throws DataValidationFailedException;
  70
  71     /**
  72      *
  73      * Performs structural verification of NodeModification, such as writen values / types uses
  74      * right structural elements.
  75      *
  76      * @param modification data to be verified.
  77      * @param verifyChildren true if structure verification should be run against children.
  78      * @throws IllegalArgumentException If provided NodeModification does not adhere to the
  79      *         structure.
  80      */
  81     abstract void verifyStructure(NormalizedNode<?, ?> modification, boolean verifyChildren)
  82             throws IllegalArgumentException;
  83
  84     /**
  85      * Return the tracking policy for this node's children.
  86      *
  87      * @return Tracking policy, may not be null.
  88      */
  89     abstract ChildTrackingPolicy getChildPolicy();
  90
  91     /**
  92      * Stage a merge operation into a {@link ModifiedNode} such that it will be processed correctly by
  93      * {@link #apply(ModifiedNode, Optional, Version)}. This method is the context which is introducing this operation,
  94      * and so any overheads are charged to whoever is in control of the access pattern.
  95      *
  96      * @param modification Original modification node
  97      * @param value Value which should be merge into the modification
  98      * @param version Data version as carried in the containing {@link InMemoryDataTreeModification}
  99      */
 100     abstract void mergeIntoModifiedNode(ModifiedNode modification, NormalizedNode<?, ?> value, Version version);
 101
 102     /**
 103      * Returns a suboperation for specified tree node
 104      *
 105      * @return Reference to suboperation for specified tree node, {@link Optional#absent()}
 106      *    if suboperation is not supported for specified tree node.
 107      */
 108     @Override
 109     public abstract Optional<ModificationApplyOperation> getChild(PathArgument child);
 110
 111     abstract void recursivelyVerifyStructure(NormalizedNode<?, ?> value);
 112 }