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.api.schema.tree.spi;
11 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
12 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
13 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
16 * A mutable tree node. This is a transient view materialized from a pre-existing
17 * node. Modifications are isolated. Once this object is {@link #seal()}-ed,
18 * any interactions with it will result in undefined behavior.
20 public interface MutableTreeNode extends StoreTreeNode<TreeNode> {
22 * Set the data component of the node.
24 * @param data New data component, may not be null.
26 void setData(NormalizedNode<?, ?> data);
29 * Set the new subtree version. This is typically invoked when the user
30 * has modified some of this node's children.
32 * @param subtreeVersion New subtree version.
34 void setSubtreeVersion(Version subtreeVersion);
37 * Add a new child node. This acts as add-or-replace operation, e.g. it
38 * succeeds even if a conflicting child is already present.
40 * @param child New child node.
42 void addChild(TreeNode child);
45 * Remove a child node. This acts as delete-or-nothing operation, e.g. it
46 * succeeds even if the corresponding child is not present.
48 * @param id Child identificator.
50 void removeChild(PathArgument id);
53 * Finish node modification and return a read-only view of this node. After
54 * this method is invoked, any further calls to this object's method result
55 * in undefined behavior.
57 * @return Read-only view of this node.