2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
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.tree.StoreTreeNode;
14 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
15 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
16 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
20 * Operation responsible for applying {@link ModifiedNode} on tree.
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.
26 * <b>Implementation notes</b>
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.
35 * Hierarchical composite operation which is responsible for applying
36 * modification on particular subtree and creating updated subtree
40 interface ModificationApplyOperation extends StoreTreeNode<ModificationApplyOperation> {
44 * Implementation of this operation must be stateless and must not change
45 * state of this object.
48 * NodeModification to be applied
50 * Store Metadata Node on which NodeModification should be
52 * @param version New subtree version of parent node
53 * @throws IllegalArgumentException
54 * If it is not possible to apply Operation on provided Metadata
56 * @return new {@link StoreMetadataNode} if operation resulted in updating
57 * node, {@link Optional#absent()} if {@link ModifiedNode}
58 * resulted in deletion of this node.
60 Optional<TreeNode> apply(ModifiedNode modification, Optional<TreeNode> storeMeta, Version version);
64 * Performs structural verification of NodeModification, such as writen values / types
65 * uses right structural elements.
67 * @param modification to be verified.
68 * @throws IllegalArgumentException If provided NodeModification does not adhere to the structure.
70 void verifyStructure(ModifiedNode modification) throws IllegalArgumentException;
73 * Returns a suboperation for specified tree node
75 * @return Reference to suboperation for specified tree node, {@link Optional#absent()}
76 * if suboperation is not supported for specified tree node.
79 Optional<ModificationApplyOperation> getChild(PathArgument child);
83 * Checks if provided node modification could be applied to current metadata node.
85 * @param modification Modification
86 * @param current Metadata Node to which modification should be applied
87 * @return true if modification is applicable
88 * false if modification is no applicable
89 * @throws DataValidationFailedException
91 void checkApplicable(YangInstanceIdentifier path, NodeModification modification, Optional<TreeNode> current) throws DataValidationFailedException;