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 // FIXME: 3.0.0: Use @NonNullByDefault
  33 public interface TreeNode extends Identifiable<PathArgument>, StoreTreeNode<TreeNode> {
  34     /**
  35      * Get the data node version. This version is updated whenever the data representation of this particular node
  36      * changes as a result of a direct write to this node or to its parent nodes -- thus indicating that this node
  37      * was logically replaced.
  38      *
  39      * @return Current data node version.
  40      */
  41     Version getVersion();
  42
  43     /**
  44      * Get the subtree version. This version is updated whenever the data representation of this particular node
  45      * changes as the result of a direct or indirect child node being created, replaced or removed.
  46      *
  47      * @return Current subtree version.
  48      */
  49     Version getSubtreeVersion();
  50
  51     /**
  52      * Get a read-only view of the underlying data.
  53      *
  54      * @return Unmodifiable view of the underlying data.
  55      */
  56     NormalizedNode<?, ?> getData();
  57
  58     /**
  59      * Get a mutable, isolated copy of the node.
  60      *
  61      * @return Mutable copy
  62      */
  63     MutableTreeNode mutable();
  64 }