org.apache.directory.api.ldap.extras.controls.syncrepl_impl

Enum SyncRequestValueStatesEnum

java.lang.Object

java.lang.Enum<SyncRequestValueStatesEnum>

org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncRequestValueStatesEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SyncRequestValueStatesEnum>, States

public enum SyncRequestValueStatesEnum
extends java.lang.Enum<SyncRequestValueStatesEnum>
implements States

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
COOKIE_STATE cookie Value
END_STATE The END_STATE
LAST_SYNC_REQUEST_VALUE_STATE terminal state
MODE_STATE mode Value
RELOAD_HINT_STATE reloadHint Value
START_STATE Initial state
SYNC_REQUEST_VALUE_SEQUENCE_STATE Sequence Value

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGrammarName(Grammar<SyncRequestValueContainer> grammar) Get the grammar name
java.lang.String	getGrammarName(int grammar) Get the grammar name
SyncRequestValueStatesEnum	getStartState()
java.lang.String	getState(int state) Get the string representing the state
boolean	isEndState()
static SyncRequestValueStatesEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SyncRequestValueStatesEnum[]	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

END_STATE

public static final SyncRequestValueStatesEnum END_STATE

The END_STATE

START_STATE

public static final SyncRequestValueStatesEnum START_STATE

Initial state

SYNC_REQUEST_VALUE_SEQUENCE_STATE

public static final SyncRequestValueStatesEnum SYNC_REQUEST_VALUE_SEQUENCE_STATE

Sequence Value

MODE_STATE

public static final SyncRequestValueStatesEnum MODE_STATE

mode Value

COOKIE_STATE

public static final SyncRequestValueStatesEnum COOKIE_STATE

cookie Value

RELOAD_HINT_STATE

public static final SyncRequestValueStatesEnum RELOAD_HINT_STATE

reloadHint Value

LAST_SYNC_REQUEST_VALUE_STATE

public static final SyncRequestValueStatesEnum LAST_SYNC_REQUEST_VALUE_STATE

terminal state

Method Detail

values

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

Returns:

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

valueOf

public static SyncRequestValueStatesEnum valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getGrammarName

public java.lang.String getGrammarName(int grammar)

Get the grammar name

Parameters:

grammar - The grammar code

Returns:

The grammar name

getGrammarName

public java.lang.String getGrammarName(Grammar<SyncRequestValueContainer> grammar)

Get the grammar name

Parameters:

grammar - The grammar class

Returns:

The grammar name

getState

public java.lang.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 SyncRequestValueStatesEnum getStartState()

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum