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 transitionEND_STATE
Final stateORDER_RULE_STATE
orderingRule [0] MatchingRuleId OPTIONAL transitionREVERSE_ORDER_STATE
reverseOrder [1] BOOLEAN DEFAULT FALSE transitionSEQUENCE_OF_SEQUENCE_STATE
SortKeyList ::= SEQUENCE OF transitionSORT_KEY_SEQUENCE_STATE
SortKeyList ::= SEQUENCE OF SEQUENCE transitionSTART_STATE
Initial state
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getGrammarName()
Get the grammar nameEnum<?>
getStartState()
String
getState(int state)
Get the string representing the stateboolean
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.
-
-
-
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 nameNullPointerException
- 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 interfaceStates
- Returns:
- True if this is the END_STATE
-
getStartState
public Enum<?> getStartState()
- Specified by:
getStartState
in interfaceStates
- Returns:
- The START_STATE of the enum
-
-