Package org.apache.directory.api.ldap.codec.controls.sort

Enum SortRequestStates

java.lang.Object

java.lang.Enum<SortRequestStates>

org.apache.directory.api.ldap.codec.controls.sort.SortRequestStates

All Implemented Interfaces:

Serializable, Comparable<SortRequestStates>, States

public enum SortRequestStates
extends Enum<SortRequestStates>
implements States

Codec states for SortRequestControl.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
AT_DESC_STATE	attributeType AttributeDescription transition
END_STATE	Final state
ORDER_RULE_STATE	orderingRule [0] MatchingRuleId OPTIONAL transition
REVERSE_ORDER_STATE	reverseOrder [1] BOOLEAN DEFAULT FALSE transition
SEQUENCE_OF_SEQUENCE_STATE	SortKeyList ::= SEQUENCE OF transition
SORT_KEY_SEQUENCE_STATE	SortKeyList ::= SEQUENCE OF SEQUENCE transition
START_STATE	Initial state

Method Summary

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

START_STATE

public static final SortRequestStates START_STATE

Initial state

SEQUENCE_OF_SEQUENCE_STATE

public static final SortRequestStates SEQUENCE_OF_SEQUENCE_STATE

SortKeyList ::= SEQUENCE OF transition

SORT_KEY_SEQUENCE_STATE

public static final SortRequestStates SORT_KEY_SEQUENCE_STATE

SortKeyList ::= SEQUENCE OF SEQUENCE transition

AT_DESC_STATE

public static final SortRequestStates AT_DESC_STATE

attributeType AttributeDescription transition

ORDER_RULE_STATE

public static final SortRequestStates ORDER_RULE_STATE

orderingRule [0] MatchingRuleId OPTIONAL transition

REVERSE_ORDER_STATE

public static final SortRequestStates REVERSE_ORDER_STATE

reverseOrder [1] BOOLEAN DEFAULT FALSE transition

END_STATE

public static final SortRequestStates END_STATE

Final state

Method Detail

values

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

Returns:

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

valueOf

public static SortRequestStates 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 Enum<?> getStartState()

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum