Package org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727

Enum Class OfpRole

java.lang.Object

java.lang.Enum<OfpRole>

org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole

All Implemented Interfaces:

Serializable, Comparable<OfpRole>, Constable, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.Enumeration, org.opendaylight.yangtools.yang.binding.TypeObject

@Generated("mdsal-binding-generator")
public enum OfpRole
extends Enum<OfpRole>
implements org.opendaylight.yangtools.yang.binding.Enumeration

This class represents the following YANG schema fragment defined in module sal-role

 typedef ofp-role {
   type enumeration {
     enum NOCHANGE {
     }
     enum BECOMEMASTER {
     }
     enum BECOMESLAVE {
     }
   }
 }
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BECOMEMASTER	promote current role to MASTER
BECOMESLAVE	demote current role to SLAVE
NOCHANGE	no change to role

Method Summary

Modifier and Type	Method	Description
static @Nullable OfpRole	forName(String name)	Return the enumeration member whose getName() matches specified assigned name.
static @Nullable OfpRole	forValue(int intValue)	Return the enumeration member whose getIntValue() matches specified value.
int	getIntValue()
@NonNull String	getName()
static @NonNull OfpRole	ofName(String name)	Return the enumeration member whose getName() matches specified assigned name.
static @NonNull OfpRole	ofValue(int intValue)	Return the enumeration member whose getIntValue() matches specified value.
static OfpRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OfpRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOCHANGE

public static final OfpRole NOCHANGE

no change to role

BECOMEMASTER

public static final OfpRole BECOMEMASTER

promote current role to MASTER

BECOMESLAVE

public static final OfpRole BECOMESLAVE

demote current role to SLAVE

Method Details

values

public static OfpRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OfpRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public @NonNull String getName()

Specified by:

getName in interface org.opendaylight.yangtools.yang.binding.Enumeration

getIntValue

public int getIntValue()

Specified by:

getIntValue in interface org.opendaylight.yangtools.yang.binding.Enumeration

forName

public static @Nullable OfpRole forName(String name)

Return the enumeration member whose getName() matches specified assigned name.

Parameters:

name - YANG assigned name

Returns:

corresponding OfpRole item, or null if no such item exists

Throws:

NullPointerException - if name is null

forValue

public static @Nullable OfpRole forValue(int intValue)

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

Parameters:

intValue - integer value

Returns:

corresponding OfpRole item, or null if no such item exists

ofName

public static @NonNull OfpRole ofName(String name)

Return the enumeration member whose getName() matches specified assigned name.

Parameters:

name - YANG assigned name

Returns:

corresponding OfpRole item

Throws:

NullPointerException - if name is null

IllegalArgumentException - if name does not match any item

ofValue

public static @NonNull OfpRole ofValue(int intValue)

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

Parameters:

intValue - integer value

Returns:

corresponding OfpRole item

Throws:

IllegalArgumentException - if intValue does not match any item