org.opendaylight.mdsal.binding.dom.adapter

Enum BindingStructuralType

java.lang.Object

java.lang.Enum<BindingStructuralType>

org.opendaylight.mdsal.binding.dom.adapter.BindingStructuralType

All Implemented Interfaces:

Serializable, Comparable<BindingStructuralType>

@Beta
public enum BindingStructuralType
extends Enum<BindingStructuralType>

Defines structural mapping of Normalized Node to Binding data addressable by Instance Identifier. Not all binding data are addressable by instance identifier and there are some differences.

See NOT_ADDRESSABLE,INVISIBLE_CONTAINER,VISIBLE_CONTAINER for more details.

NOTE: this class is exposed for migration purposes only, no new users outside of its package should be introduced.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVISIBLE_CONTAINER Data container is addressable in NormalizedNode format, but in Binding it is not represented in InstanceIdentifier.
INVISIBLE_LIST Data container is addressable in NormalizedNode format, but in Binding it is not represented in InstanceIdentifier.
NOT_ADDRESSABLE DOM Item is not addressable in Binding InstanceIdentifier, data is not lost, but are available only via parent object.
UNKNOWN Mapping algorithm was unable to detect type or was not updated after introduction of new NormalizedNode type.
VISIBLE_CONTAINER Data container is addressable in Binding InstanceIdentifier format and also YangInstanceIdentifier format.

Method Summary

Modifier and Type	Method and Description
static BindingStructuralType	from(org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode domChildNode)
static BindingStructuralType	recursiveFrom(org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode node)
static BindingStructuralType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BindingStructuralType[]	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

NOT_ADDRESSABLE

public static final BindingStructuralType NOT_ADDRESSABLE

DOM Item is not addressable in Binding InstanceIdentifier, data is not lost, but are available only via parent object. Such types of data are leaf-lists, leafs, list without keys or anyxml.

INVISIBLE_CONTAINER

public static final BindingStructuralType INVISIBLE_CONTAINER

Data container is addressable in NormalizedNode format, but in Binding it is not represented in InstanceIdentifier. These are choice / case nodes.

This data is still accessible using parent object and their children are addressable.

INVISIBLE_LIST

public static final BindingStructuralType INVISIBLE_LIST

Data container is addressable in NormalizedNode format, but in Binding it is not represented in InstanceIdentifier. These are list nodes.

This data is still accessible using parent object and their children are addressable.

VISIBLE_CONTAINER

public static final BindingStructuralType VISIBLE_CONTAINER

Data container is addressable in Binding InstanceIdentifier format and also YangInstanceIdentifier format.

UNKNOWN

public static final BindingStructuralType UNKNOWN

Mapping algorithm was unable to detect type or was not updated after introduction of new NormalizedNode type.

Method Detail

values

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

Returns:

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

valueOf

public static BindingStructuralType 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

from

public static BindingStructuralType from(org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode domChildNode)

recursiveFrom

public static BindingStructuralType recursiveFrom(org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode node)