yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/tree/spi/MutableTreeNode.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
  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 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.
  19  */
  20 public interface MutableTreeNode extends StoreTreeNode<TreeNode> {
  21     /**
  22      * Set the data component of the node.
  23      *
  24      * @param data New data component, may not be null.
  25      */
  26     void setData(NormalizedNode<?, ?> data);
  27
  28     /**
  29      * Set the new subtree version. This is typically invoked when the user
  30      * has modified some of this node's children.
  31      *
  32      * @param subtreeVersion New subtree version.
  33      */
  34     void setSubtreeVersion(Version subtreeVersion);
  35
  36     /**
  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.
  39      *
  40      * @param child New child node.
  41      */
  42     void addChild(TreeNode child);
  43
  44     /**
  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.
  47      *
  48      * @param id Child identificator.
  49      */
  50     void removeChild(PathArgument id);
  51
  52     /**
  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.
  56      *
  57      * @return Read-only view of this node.
  58      */
  59     TreeNode seal();
  60 }