org.opendaylight.controller.md.sal.common.api.data

Enum AsyncDataBroker.DataChangeScope

java.lang.Object

java.lang.Enum<AsyncDataBroker.DataChangeScope>

org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope

All Implemented Interfaces:

Serializable, Comparable<AsyncDataBroker.DataChangeScope>

Enclosing interface:

AsyncDataBroker<P extends org.opendaylight.yangtools.concepts.Path<P>,D,L extends AsyncDataChangeListener<P,D>>

public static enum AsyncDataBroker.DataChangeScope
extends Enum<AsyncDataBroker.DataChangeScope>

Scope of Data Change

Represents scope of data change (addition, replacement, deletion). The terminology for scope types is reused from LDAP.

Examples

Following is an example model with comments describing what notifications you would receive based on the scope you specify, when you are registering for changes on container a.

 container a              // scope BASE, ONE, SUBTREE
    leaf "foo"            // scope ONE, SUBTREE
    container             // scope ONE, SUBTREE
       leaf  "bar"        // scope SUBTREE
    list list             // scope ONE, SUBTREE
      list [a]            // scope SUBTREE
        id "a"            // scope SUBTREE
      list [b]            // scope SUBTREE
        id "b"            // scope SUBTREE
 

Following is an example model with comments describing what notifications you would receive based on the scope you specify, when you are registering for changes on list list (without specifying concrete item in the list).

  list list               // scope BASE, ONE, SUBTREE
      list [a]            // scope ONE, SUBTREE
        id "a"            // scope SUBTREE
      list [b]            // scope ONE, SUBTREE
        id "b"            // scope SUBTREE
 

See Also:

LDAP

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE Represents only a direct change of the node, such as replacement of a node, addition or deletion.
ONE Represent a change (addition,replacement,deletion) of the node or one of its direct children.
SUBTREE Represents a change of the node or any of or any of its child nodes, direct and nested.

Method Summary

Modifier and Type	Method and Description
static AsyncDataBroker.DataChangeScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static AsyncDataBroker.DataChangeScope[]	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

BASE

public static final AsyncDataBroker.DataChangeScope BASE

Represents only a direct change of the node, such as replacement of a node, addition or deletion. Note that, as described in ONE, this may have counterintuitive interactions when viewed from a binding aware application, in particular when it pertains to lists.

ONE

public static final AsyncDataBroker.DataChangeScope ONE

Represent a change (addition,replacement,deletion) of the node or one of its direct children.

Note that this is done in the binding independent data tree and so the behavior might be counterintuitive when used with binding aware interfaces particularly when it comes to lists. The list itself is a node in the binding independent tree, which means that if you want to listen on new elements you must listen on the list itself with the scope of ONE.

As an example, in the below YANG snippet, listening on node with scope ONE would tell you if the node-connector list was created or deleted, but not when elements were added or removed from the list assuming the list itself already existed.

 container nodes {
   list node {
     key "id";
     leaf id {
       type string;
     }
     list node-connector {
       leaf id {
         type string;
       }
     }
   }
 }
 

This scope is superset of BASE.

SUBTREE

public static final AsyncDataBroker.DataChangeScope SUBTREE

Represents a change of the node or any of or any of its child nodes, direct and nested. This scope is superset of ONE and BASE.

Method Detail

values

public static AsyncDataBroker.DataChangeScope[] 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 (AsyncDataBroker.DataChangeScope c : AsyncDataBroker.DataChangeScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static AsyncDataBroker.DataChangeScope 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