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

Enum StandbyState

java.lang.Object

java.lang.Enum<StandbyState>

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

All Implemented Interfaces:

Serializable, Comparable<StandbyState>, Enumeration

public enum StandbyState
extends Enum<StandbyState>
implements Enumeration

Enum Constant Summary

Enum Constants

Enum Constant and Description
ColdStandby The resource is to back up another resource, but it willnot be immediately able to take over the role of aresource to be backed up and will require someinitialization activity.
HotStandby The resource is not providing service, but it will beimmediately able to take over the role of the resource tobe backed up, without the need for initializationactivity, and will contain the same information as theresource to be backed up.
ProvidingService The resource is providing service.
Unknown The resource is unable to report standby state.

Method Summary

Modifier and Type	Method and Description
static Optional<StandbyState>	forName(String name) Return the enumeration member whose getName() matches specified value.
static StandbyState	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 StandbyState	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandbyState[]	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 StandbyState Unknown

The resource is unable to report standby state.

HotStandby

public static final StandbyState HotStandby

The resource is not providing service, but it will beimmediately able to take over the role of the resource tobe backed up, without the need for initializationactivity, and will contain the same information as theresource to be backed up.

ColdStandby

public static final StandbyState ColdStandby

The resource is to back up another resource, but it willnot be immediately able to take over the role of aresource to be backed up and will require someinitialization activity.

ProvidingService

public static final StandbyState ProvidingService

The resource is providing service.

Method Detail

values

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

Returns:

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

valueOf

public static StandbyState 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<StandbyState> forName(String name)

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

Parameters:

name - YANG assigned name

Returns:

corresponding StandbyState item, if present

Throws:

NullPointerException - if name is null

forValue

public static StandbyState forValue(int intValue)

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

Parameters:

intValue - integer value

Returns:

corresponding StandbyState item, or null if no such item exists