Fix eclipse/checkstyle warnings
[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / tree / spi / TreeNode.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.api.schema.tree.spi;
9
10 import org.opendaylight.yangtools.concepts.Identifiable;
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.StoreTreeNode;
14
15 /**
16  * A very basic data tree node. It has a version (when it was last modified), a subtree version (when any of its
17  * children were modified) and some read-only data.
18  *
19  * <p>
20  * Semantic difference between these two is important when dealing with modifications involving parent/child
21  * relationships and what operations can be execute concurrently without creating a data dependency conflict.
22  *
23  * <p>
24  * A replace/delete operation cannot be applied to this node if the subtree version does not match. This mismatch
25  * still allows modifications to its descendants.
26  *
27  * <p>
28  * A mismatch in node version indicates a replacement, preventing a modification of descendants or itself.
29  */
30 // FIXME: BUG-2399: clarify that versioning rules are not enforced for non-presence containers, as they are not
31 //                  considered to be data nodes.
32 public interface TreeNode extends Identifiable<PathArgument>, StoreTreeNode<TreeNode> {
33     /**
34      * Get the data node version. This version is updated whenever the data representation of this particular node
35      * changes as a result of a direct write to this node or to its parent nodes -- thus indicating that this node
36      * was logically replaced.
37      *
38      * @return Current data node version.
39      */
40     Version getVersion();
41
42     /**
43      * Get the subtree version. This version is updated whenever the data representation of this particular node
44      * changes as the result of a direct or indirect child node being created, replaced or removed.
45      *
46      * @return Current subtree version.
47      */
48     Version getSubtreeVersion();
49
50     /**
51      * Get a read-only view of the underlying data.
52      *
53      * @return Unmodifiable view of the underlying data.
54      */
55     NormalizedNode<?, ?> getData();
56
57     /**
58      * Get a mutable, isolated copy of the node.
59      *
60      * @return Mutable copy
61      */
62     MutableTreeNode mutable();
63 }