org.onosproject.yms.ydt

Enum YdtType

java.lang.Object

java.lang.Enum<YdtType>

org.onosproject.yms.ydt.YdtType

All Implemented Interfaces:

Serializable, Comparable<YdtType>

public enum YdtType
extends Enum<YdtType>

Represents type of node in YANG data tree. Protocols based on input data format provide this information to YMS during YDT building. YMS use this information to carry out the validation against the schema information obtained as a part of application registration. Also as a part of response YMS encode this information in YDT node, protocol may use this information while construction the data format string. Protocols unaware of node type like NETCONF, may opt not to provide this information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOGICAL_ROOT_NODE Logical root node.
MULTI_INSTANCE_LEAF_VALUE_NODE Multi instance leaf node.
MULTI_INSTANCE_NODE Multi instance node.
SINGLE_INSTANCE_LEAF_VALUE_NODE Single instance leaf node.
SINGLE_INSTANCE_NODE Single instance node.

Method Summary

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

SINGLE_INSTANCE_NODE

public static final YdtType SINGLE_INSTANCE_NODE

Single instance node.

MULTI_INSTANCE_NODE

public static final YdtType MULTI_INSTANCE_NODE

Multi instance node.

SINGLE_INSTANCE_LEAF_VALUE_NODE

public static final YdtType SINGLE_INSTANCE_LEAF_VALUE_NODE

Single instance leaf node.

MULTI_INSTANCE_LEAF_VALUE_NODE

public static final YdtType MULTI_INSTANCE_LEAF_VALUE_NODE

Multi instance leaf node.

LOGICAL_ROOT_NODE

public static final YdtType LOGICAL_ROOT_NODE

Logical root node.

Method Detail

values

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

Returns:

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

valueOf

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