org.onosproject.yang.model

Enum LeafType

java.lang.Object

java.lang.Enum<LeafType>

org.onosproject.yang.model.LeafType

All Implemented Interfaces:

Serializable, Comparable<LeafType>

public enum LeafType
extends Enum<LeafType>

Represents ENUM to identify the effective built in data type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Reference:RFC 6020.
BITS Reference:RFC 6020.
BOOLEAN Reference:RFC 6020.
DECIMAL64 Reference:RFC 6020.
EMPTY Reference:RFC 6020.
ENUMERATION Reference:RFC 6020.
IDENTITYREF Reference:RFC 6020.
INSTANCE_IDENTIFIER Reference:RFC 6020.
INT16 Reference:RFC 6020.
INT32 Reference:RFC 6020.
INT64 Reference:RFC 6020.
INT8 Reference:RFC 6020.
STRING Reference:RFC 6020.
UINT16 Reference:RFC 6020.
UINT32 Reference:RFC 6020.
UINT64 Reference:RFC 6020.
UINT8 Reference:RFC 6020.

Method Summary

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

INT8

public static final LeafType INT8

Reference:RFC 6020.

int8 represents integer values between -128 and 127, inclusively.

INT16

public static final LeafType INT16

Reference:RFC 6020.

int16 represents integer values between -32768 and 32767, inclusively.

INT32

public static final LeafType INT32

Reference:RFC 6020.

int32 represents integer values between -2147483648 and 2147483647, inclusively.

INT64

public static final LeafType INT64

Reference:RFC 6020.

int64 represents integer values between -9223372036854775808 and 9223372036854775807, inclusively.

UINT8

public static final LeafType UINT8

Reference:RFC 6020.

uint8 represents integer values between 0 and 255, inclusively.

UINT16

public static final LeafType UINT16

Reference:RFC 6020.

uint16 represents integer values between 0 and 65535, inclusively.

UINT32

public static final LeafType UINT32

Reference:RFC 6020.

uint32 represents integer values between 0 and 4294967295, inclusively.

UINT64

public static final LeafType UINT64

Reference:RFC 6020.

uint64 represents integer values between 0 and 18446744073709551615, inclusively.

DECIMAL64

public static final LeafType DECIMAL64

Reference:RFC 6020.

The decimal64 type represents a subset of the real numbers, which can be represented by decimal numerals. The value space of decimal64 is the set of numbers that can be obtained by multiplying a 64-bit signed integer by a negative power of ten, i.e., expressible as "i x 10^-n" where i is an integer64 and n is an integer between 1 and 18, inclusively.

STRING

public static final LeafType STRING

Reference:RFC 6020.

The string built-in type represents human-readable strings in YANG. Legal characters are tab, carriage return, line feed, and the legal characters of Unicode and ISO/IEC 10646

BOOLEAN

public static final LeafType BOOLEAN

Reference:RFC 6020.

The boolean built-in type represents a boolean value.

ENUMERATION

public static final LeafType ENUMERATION

Reference:RFC 6020.

The enumeration built-in type represents values from a set of assigned names.

BITS

public static final LeafType BITS

Reference:RFC 6020.

The bits built-in type represents a bit set. That is, a bits value is a set of flags identified by small integer position numbers starting at 0. Each bit number has an assigned name.

BINARY

public static final LeafType BINARY

Reference:RFC 6020.

The binary built-in type represents any binary data, i.e., a sequence of octets.

IDENTITYREF

public static final LeafType IDENTITYREF

Reference:RFC 6020.

The identityref type is used to reference an existing identity.

EMPTY

public static final LeafType EMPTY

Reference:RFC 6020.

The empty built-in type represents a leaf that does not have any value, it conveys information by its presence or absence.

An empty type cannot have a default value.

INSTANCE_IDENTIFIER

public static final LeafType INSTANCE_IDENTIFIER

Reference:RFC 6020.

The instance-identifier built-in type is used to uniquely identify a particular instance node in the data tree.

The syntax for an instance-identifier is a subset of the XPath abbreviated syntax, formally defined by the rule "instance-identifier". It is used to uniquely identify a node in the data tree. Predicates are used only for specifying the values for the key nodes for list entries, a value of a leaf-list entry, or a positional index for a list without keys. For identifying list entries with keys, each predicate consists of one equality test per key, and each key MUST have a corresponding predicate.

If the leaf with the instance-identifier type represents configuration data, and the "require-instance" property is "true", the node it refers to MUST also represent configuration. Such a leaf puts a constraint on valid data. All such leaf nodes MUST reference existing nodes or leaf nodes with their default value in use for the data to be valid.

Method Detail

values

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

Returns:

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

valueOf

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