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;
11 * Enumeration of all possible node modification states. These are used in data tree modification context to quickly
12 * assess what sort of modification the node is undergoing.
14 public enum ModificationType {
16 * Node is currently unmodified.
21 * A child node, either direct or indirect, has been modified. This means
22 * that the data representation of this node has potentially changed.
27 * This node has been placed into the tree, potentially completely replacing
28 * pre-existing contents.
33 * This node has been deleted along with any of its child nodes.
38 * This node has appeared because it is implied by one of its children. This type is usually produced when a
39 * structural container is created to host some leaf entries. It does not have an associated before-image.
42 * Its semantics is a combination of SUBTREE_MODIFIED and WRITE, depending on which context it is being interpreted.
45 * Users who track the value of the node can treat it as a WRITE. Users transforming a {@link DataTreeCandidate} to
46 * operations on a {@link DataTreeModification} should interpret it as a SUBTREE_MODIFIED and examine its children.
47 * This is needed to correctly deal with concurrent operations on the nodes children, as issuing a write on the
48 * DataTreeModification could end up removing any leaves which have not been present at the DataTree which emitted
54 * This node has disappeared because it is no longer implied by any children. This type is usually produced when a
55 * structural container is removed because it has become empty. It does not have an associated after-image.
58 * Its semantics is a combination of SUBTREE_MODIFIED and DELETE, depending on which context it is being
59 * interpreted. Users who track the value of the node can treat it as a DELETE, as the container has disappeared.
60 * Users transforming a {@link DataTreeCandidate} to operations on a {@link DataTreeModification} should interpret
61 * it as a SUBTREE_MODIFIED and examine its children.
64 * This is needed to correctly deal with concurrent operations on the nodes children, as issuing a delete on the
65 * DataTreeModification would end up removing any leaves which have not been present at the DataTree which emitted