Enum PagedResultsStates
- java.lang.Object
-
- java.lang.Enum<PagedResultsStates>
-
- org.apache.directory.api.ldap.codec.controls.search.pagedSearch.PagedResultsStates
-
- All Implemented Interfaces:
Serializable
,Comparable<PagedResultsStates>
,States
public enum PagedResultsStates extends Enum<PagedResultsStates> implements States
This class store the PagedSearchControl'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 ValueEND_STATE
The END_STATELAST_PAGED_SEARCH_STATE
terminal statePAGED_SEARCH_SEQUENCE_STATE
Sequence ValueSIZE_STATE
Size ValueSTART_STATE
Initial state
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getGrammarName()
Get the grammar namePagedResultsStates
getStartState()
String
getState(int state)
Get the string representing the stateboolean
isEndState()
static PagedResultsStates
valueOf(String name)
Returns the enum constant of this type with the specified name.static PagedResultsStates[]
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 PagedResultsStates END_STATE
The END_STATE
-
START_STATE
public static final PagedResultsStates START_STATE
Initial state
-
PAGED_SEARCH_SEQUENCE_STATE
public static final PagedResultsStates PAGED_SEARCH_SEQUENCE_STATE
Sequence Value
-
SIZE_STATE
public static final PagedResultsStates SIZE_STATE
Size Value
-
COOKIE_STATE
public static final PagedResultsStates COOKIE_STATE
Cookie Value
-
LAST_PAGED_SEARCH_STATE
public static final PagedResultsStates LAST_PAGED_SEARCH_STATE
terminal state
-
-
Method Detail
-
values
public static PagedResultsStates[] 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 (PagedResultsStates c : PagedResultsStates.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PagedResultsStates 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 PagedResultsStates getStartState()
- Specified by:
getStartState
in interfaceStates
- Returns:
- The START_STATE of the enum
-
-