Package org.apache.directory.api.ldap.extras.extended.ads_impl.endTransaction.controls

Enum ControlsStates

java.lang.Object

java.lang.Enum<ControlsStates>

org.apache.directory.api.ldap.extras.extended.ads_impl.endTransaction.controls.ControlsStates

All Implemented Interfaces:

Serializable, Comparable<ControlsStates>, States

public enum ControlsStates
extends Enum<ControlsStates>
implements States

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

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTROL_CRITICALITY_STATE	The criticality
CONTROL_SEQUENCE_STATE	The Control SEQUENCE
CONTROL_TYPE_STATE	The Control type
CONTROL_VALUE_STATE	The value
END_STATE	The END_STATE
LAST_STATE	Last state
START_STATE	start state

Method Summary

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

The END_STATE

START_STATE

public static final ControlsStates START_STATE

start state

CONTROL_SEQUENCE_STATE

public static final ControlsStates CONTROL_SEQUENCE_STATE

The Control SEQUENCE

CONTROL_TYPE_STATE

public static final ControlsStates CONTROL_TYPE_STATE

The Control type

CONTROL_CRITICALITY_STATE

public static final ControlsStates CONTROL_CRITICALITY_STATE

The criticality

CONTROL_VALUE_STATE

public static final ControlsStates CONTROL_VALUE_STATE

The value

LAST_STATE

public static final ControlsStates LAST_STATE

Last state

Method Detail

values

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

Returns:

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

valueOf

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

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum