Package org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect

Enum GracefulDisconnectStatesEnum

java.lang.Object

java.lang.Enum<GracefulDisconnectStatesEnum>

org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect.GracefulDisconnectStatesEnum

All Implemented Interfaces:

Serializable, Comparable<GracefulDisconnectStatesEnum>, States

public enum GracefulDisconnectStatesEnum
extends Enum<GracefulDisconnectStatesEnum>
implements States

This class store the GracefulDisconnect's grammar constants. It is also used for debugging purposes.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELAY_STATE	Delay
END_STATE	The END_STATE
GRACEFUL_DISCONNECT_SEQUENCE_STATE	Sequence
LAST_GRACEFUL_DISCONNECT_STATE	terminal state
REFERRAL_STATE	Referral
REPLICATED_CONTEXTS_STATE	Replicated contexts
START_STATE	Initial state
TIME_OFFLINE_STATE	Time offline

Method Summary

Modifier and Type	Method	Description
String	getGrammarName()	Get the grammar name
GracefulDisconnectStatesEnum	getStartState()
String	getState(int state)	Get the string representing the state
boolean	isEndState()
static GracefulDisconnectStatesEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GracefulDisconnectStatesEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

END_STATE

public static final GracefulDisconnectStatesEnum END_STATE

The END_STATE

START_STATE

public static final GracefulDisconnectStatesEnum START_STATE

Initial state

GRACEFUL_DISCONNECT_SEQUENCE_STATE

public static final GracefulDisconnectStatesEnum GRACEFUL_DISCONNECT_SEQUENCE_STATE

Sequence

TIME_OFFLINE_STATE

public static final GracefulDisconnectStatesEnum TIME_OFFLINE_STATE

Time offline

DELAY_STATE

public static final GracefulDisconnectStatesEnum DELAY_STATE

Delay

REPLICATED_CONTEXTS_STATE

public static final GracefulDisconnectStatesEnum REPLICATED_CONTEXTS_STATE

Replicated contexts

REFERRAL_STATE

public static final GracefulDisconnectStatesEnum REFERRAL_STATE

Referral

LAST_GRACEFUL_DISCONNECT_STATE

public static final GracefulDisconnectStatesEnum LAST_GRACEFUL_DISCONNECT_STATE

terminal state

Method Detail

values

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

Returns:

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

valueOf

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

getGrammarName

public String getGrammarName()

Get the grammar name

Returns:

The grammar name

getState

public String getState(int state)

Get the string representing the state

Parameters:

state - The state number

Returns:

The String representing the state

isEndState

public boolean isEndState()

Specified by:

isEndState in interface States

Returns:

True if this is the END_STATE

getStartState

public GracefulDisconnectStatesEnum getStartState()

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum