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

Enum SyncStateValueStatesEnum

java.lang.Object

java.lang.Enum<SyncStateValueStatesEnum>

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

All Implemented Interfaces:

Serializable, Comparable<SyncStateValueStatesEnum>, States

public enum SyncStateValueStatesEnum
extends Enum<SyncStateValueStatesEnum>
implements States

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

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE_STATE	cookie Value
END_STATE	The END_STATE
LAST_SYNC_STATE_VALUE_STATE	terminal state
START_STATE	Initial state
SYNC_STATE_VALUE_SEQUENCE_STATE	Sequence Value
SYNC_TYPE_STATE	sync state type Value
SYNC_UUID_STATE	syncUUID Value

Method Summary

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

The END_STATE

START_STATE

public static final SyncStateValueStatesEnum START_STATE

Initial state

SYNC_STATE_VALUE_SEQUENCE_STATE

public static final SyncStateValueStatesEnum SYNC_STATE_VALUE_SEQUENCE_STATE

Sequence Value

SYNC_TYPE_STATE

public static final SyncStateValueStatesEnum SYNC_TYPE_STATE

sync state type Value

SYNC_UUID_STATE

public static final SyncStateValueStatesEnum SYNC_UUID_STATE

syncUUID Value

COOKIE_STATE

public static final SyncStateValueStatesEnum COOKIE_STATE

cookie Value

LAST_SYNC_STATE_VALUE_STATE

public static final SyncStateValueStatesEnum LAST_SYNC_STATE_VALUE_STATE

terminal state

Method Detail

values

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

Returns:

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

valueOf

public static SyncStateValueStatesEnum 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 SyncStateValueStatesEnum getStartState()

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum