org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313

Enum AdminState

java.lang.Object

java.lang.Enum<AdminState>

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.AdminState

All Implemented Interfaces:

Serializable, Comparable<AdminState>, Enumeration

public enum AdminState
extends Enum<AdminState>
implements Enumeration

Enum Constant Summary

Enum Constants

Enum Constant and Description
Locked The resource is administratively prohibited from use.
ShuttingDown The resource usage is administratively limited to currentinstances of use.
Unknown The resource is unable to report administrative state.
Unlocked The resource is not administratively prohibited fromuse.

Method Summary

Modifier and Type	Method and Description
static Optional<AdminState>	forName(String name) Return the enumeration member whose getName() matches specified value.
static AdminState	forValue(int intValue) Return the enumeration member whose getIntValue() matches specified value.
int	getIntValue() Returns the assigned value of the enumeration item as it is specified in the input YANG.
String	getName() Returns the assigned name of the enumeration item as it is specified in the input YANG.
static AdminState	valueOf(String name) Returns the enum constant of this type with the specified name.
static AdminState[]	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

Unknown

public static final AdminState Unknown

The resource is unable to report administrative state.

Locked

public static final AdminState Locked

The resource is administratively prohibited from use.

ShuttingDown

public static final AdminState ShuttingDown

The resource usage is administratively limited to currentinstances of use.

Unlocked

public static final AdminState Unlocked

The resource is not administratively prohibited fromuse.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Description copied from interface: Enumeration

Returns the assigned name of the enumeration item as it is specified in the input YANG.

Specified by:

getName in interface Enumeration

Returns:

the assigned name of the enumeration item as it is specified in the input YANG.

getIntValue

public int getIntValue()

Description copied from interface: Enumeration

Returns the assigned value of the enumeration item as it is specified in the input YANG.

Specified by:

getIntValue in interface Enumeration

Returns:

the assigned value of the enumeration item as it is specified in the input YANG.

forName

public static Optional<AdminState> forName(String name)

Return the enumeration member whose getName() matches specified value.

Parameters:

name - YANG assigned name

Returns:

corresponding AdminState item, if present

Throws:

NullPointerException - if name is null

forValue

public static AdminState forValue(int intValue)

Return the enumeration member whose getIntValue() matches specified value.

Parameters:

intValue - integer value

Returns:

corresponding AdminState item, or null if no such item exists