Enum SubentriesStates
- java.lang.Object
-
- java.lang.Enum<SubentriesStates>
-
- org.apache.directory.api.ldap.codec.controls.search.subentries.SubentriesStates
-
- All Implemented Interfaces:
Serializable
,Comparable<SubentriesStates>
,States
public enum SubentriesStates extends Enum<SubentriesStates> implements States
This class store the SubEntryControl's grammar constants. It is also used for debugging purposes.- Author:
- Apache Directory Project
-
-
Enum Constant Summary
Enum Constants Enum Constant Description END_STATE
The END_STATELAST_SUB_ENTRY_STATE
terminal stateSTART_STATE
Starting stateSUB_ENTRY_VISIBILITY_STATE
Visibility Value
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getGrammarName()
Get the grammar nameSubentriesStates
getStartState()
String
getState(int state)
Get the string representing the stateboolean
isEndState()
static SubentriesStates
valueOf(String name)
Returns the enum constant of this type with the specified name.static SubentriesStates[]
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 SubentriesStates END_STATE
The END_STATE
-
START_STATE
public static final SubentriesStates START_STATE
Starting state
-
SUB_ENTRY_VISIBILITY_STATE
public static final SubentriesStates SUB_ENTRY_VISIBILITY_STATE
Visibility Value
-
LAST_SUB_ENTRY_STATE
public static final SubentriesStates LAST_SUB_ENTRY_STATE
terminal state
-
-
Method Detail
-
values
public static SubentriesStates[] 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 (SubentriesStates c : SubentriesStates.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SubentriesStates 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 SubentriesStates getStartState()
- Specified by:
getStartState
in interfaceStates
- Returns:
- The START_STATE of the enum
-
-