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;
10 import org.eclipse.jdt.annotation.NonNullByDefault;
11 import org.opendaylight.yangtools.concepts.Identifiable;
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.StoreTreeNode;
17 * A very basic data tree node. It has a version (when it was last modified), a subtree version (when any of its
18 * children were modified) and some read-only data.
21 * Semantic difference between these two is important when dealing with modifications involving parent/child
22 * relationships and what operations can be execute concurrently without creating a data dependency conflict.
25 * A replace/delete operation cannot be applied to this node if the subtree version does not match. This mismatch
26 * still allows modifications to its descendants.
29 * A mismatch in node version indicates a replacement, preventing a modification of descendants or itself.
31 // FIXME: BUG-2399: clarify that versioning rules are not enforced for non-presence containers, as they are not
32 // considered to be data nodes.
34 public interface TreeNode extends Identifiable<PathArgument>, StoreTreeNode<TreeNode> {
36 * Get the data node version. This version is updated whenever the data representation of this particular node
37 * changes as a result of a direct write to this node or to its parent nodes -- thus indicating that this node
38 * was logically replaced.
40 * @return Current data node version.
45 * Get the subtree version. This version is updated whenever the data representation of this particular node
46 * changes as the result of a direct or indirect child node being created, replaced or removed.
48 * @return Current subtree version.
50 Version getSubtreeVersion();
53 * Get a read-only view of the underlying data.
55 * @return Unmodifiable view of the underlying data.
57 NormalizedNode<?, ?> getData();
60 * Get a mutable, isolated copy of the node.
62 * @return Mutable copy
64 MutableTreeNode mutable();