org.opendaylight.mdsal.binding.javav2.api

Enum TreeNodeModification.ModificationType

java.lang.Object

java.lang.Enum<TreeNodeModification.ModificationType>

org.opendaylight.mdsal.binding.javav2.api.TreeNodeModification.ModificationType

All Implemented Interfaces:

Serializable, Comparable<TreeNodeModification.ModificationType>

Enclosing interface:

TreeNodeModification<T extends TreeNode>

public static enum TreeNodeModification.ModificationType
extends Enum<TreeNodeModification.ModificationType>

Represents type of modification which has occured.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEARED This node has appeared because it is implied by one of its children.
DELETE Node was deleted.
DISAPPEARED This node has disappeared because it is no longer implied by any children.
SUBTREE_MODIFIED Child node (direct or indirect) was modified.
WRITE Node was explicitly created / overwritten.

Method Summary

Modifier and Type	Method and Description
static TreeNodeModification.ModificationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TreeNodeModification.ModificationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUBTREE_MODIFIED

public static final TreeNodeModification.ModificationType SUBTREE_MODIFIED

Child node (direct or indirect) was modified.

WRITE

public static final TreeNodeModification.ModificationType WRITE

Node was explicitly created / overwritten.

DELETE

public static final TreeNodeModification.ModificationType DELETE

Node was deleted.

APPEARED

public static final TreeNodeModification.ModificationType APPEARED

This node has appeared because it is implied by one of its children. This type is usually produced when a structural container is created to host some leaf entries. It does not have an associated before-image. Its semantics is a combination of SUBTREE_MODIFIED and WRITE, depending on which context it is being interpreted. Users who track the value of the node can treat it as a WRITE. Users transforming a DataTreeCandidate to operations on a DataTreeModification should interpret it as a SUBTREE_MODIFIED and examine its children. This is needed to correctly deal with concurrent operations on the nodes children, as issuing a write on the DataTreeModification could end up removing any leaves which have not been present at the DataTree which emitted this event.

DISAPPEARED

public static final TreeNodeModification.ModificationType DISAPPEARED

This node has disappeared because it is no longer implied by any children. This type is usually produced when a structural container is removed because it has become empty. It does not have an associated after-image. Its semantics is a combination of SUBTREE_MODIFIED and DELETE, depending on which context it is being interpreted. Users who track the value of the node can treat it as a DELETE, as the container has disappeared. Users transforming a DataTreeCandidate to operations on a DataTreeModification should interpret it as a SUBTREE_MODIFIED and examine its children. This is needed to correctly deal with concurrent operations on the nodes children, as issuing a delete on the DataTreeModification would end up removing any leaves which have not been present at the DataTree which emitted this event.

Method Detail

values

public static TreeNodeModification.ModificationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TreeNodeModification.ModificationType c : TreeNodeModification.ModificationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TreeNodeModification.ModificationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null