Enum PersistentSearchStates
- java.lang.Object
-
- java.lang.Enum<PersistentSearchStates>
-
- org.apache.directory.api.ldap.codec.controls.search.persistentSearch.PersistentSearchStates
-
- All Implemented Interfaces:
Serializable
,Comparable<PersistentSearchStates>
,States
public enum PersistentSearchStates extends Enum<PersistentSearchStates> implements States
This class store the PSearchControl's grammar constants. It is also used for debugging purposes.- Author:
- Apache Directory Project
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CHANGE_TYPES_STATE
changeTypes ValueCHANGES_ONLY_STATE
changesOnly ValueEND_STATE
The END_STATELAST_PSEARCH_STATE
terminal statePSEARCH_SEQUENCE_STATE
Sequence ValueRETURN_ECS_STATE
returnECs ValueSTART_STATE
Initial state
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getGrammarName()
Get the grammar namePersistentSearchStates
getStartState()
String
getState(int state)
Get the string representing the stateboolean
isEndState()
static PersistentSearchStates
valueOf(String name)
Returns the enum constant of this type with the specified name.static PersistentSearchStates[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
END_STATE
public static final PersistentSearchStates END_STATE
The END_STATE
-
START_STATE
public static final PersistentSearchStates START_STATE
Initial state
-
PSEARCH_SEQUENCE_STATE
public static final PersistentSearchStates PSEARCH_SEQUENCE_STATE
Sequence Value
-
CHANGE_TYPES_STATE
public static final PersistentSearchStates CHANGE_TYPES_STATE
changeTypes Value
-
CHANGES_ONLY_STATE
public static final PersistentSearchStates CHANGES_ONLY_STATE
changesOnly Value
-
RETURN_ECS_STATE
public static final PersistentSearchStates RETURN_ECS_STATE
returnECs Value
-
LAST_PSEARCH_STATE
public static final PersistentSearchStates LAST_PSEARCH_STATE
terminal state
-
-
Method Detail
-
values
public static PersistentSearchStates[] 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 (PersistentSearchStates c : PersistentSearchStates.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PersistentSearchStates 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 PersistentSearchStates getStartState()
- Specified by:
getStartState
in interfaceStates
- Returns:
- The START_STATE of the enum
-
-