Package org.opendaylight.protocol.bgp.rib.spi

Enum State

java.lang.Object

java.lang.Enum<State>

org.opendaylight.protocol.bgp.rib.spi.State

All Implemented Interfaces:

Serializable, Comparable<State>

public enum State
extends Enum<State>

Internal session state.

Enum Constant Summary

Enum Constants

Enum Constant	Description
IDLE	The session has been closed.
OPEN_CONFIRM	The session object is created by the negotiator in OpenConfirm state.
UP	The session has been completely established.

Method Summary

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

OPEN_CONFIRM

public static final State OPEN_CONFIRM

The session object is created by the negotiator in OpenConfirm state. While in this state, the session object is half-alive, e.g. the timers are running, but the session is not completely up, e.g. it has not been announced to the listener. If the session is torn down in this state, we do not inform the listener.

UP

public static final State UP

The session has been completely established.

IDLE

public static final State IDLE

The session has been closed. It will not be resurrected.

Method Detail

values

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

Returns:

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

valueOf

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

forValue

public static State forValue(short value)

getValue

public short getValue()