Package org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI

Enum WhoAmIResponseStatesEnum

java.lang.Object

java.lang.Enum<WhoAmIResponseStatesEnum>

org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI.WhoAmIResponseStatesEnum

All Implemented Interfaces:

Serializable, Comparable<WhoAmIResponseStatesEnum>, States

public enum WhoAmIResponseStatesEnum
extends Enum<WhoAmIResponseStatesEnum>
implements States

This class store the WhoAmIResponse's grammar constants. It is also used for debugging purposes.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHZ_ID_RESPONSE_STATE	the authzid
END_STATE	The END_STATE
LAST_WHO_AM_I_RESPONSE_STATE	Last state
START_STATE	start state

Method Summary

Modifier and Type	Method	Description
String	getGrammarName()	Get the grammar name
WhoAmIResponseStatesEnum	getStartState()
String	getState(int state)	Get the string representing the state
boolean	isEndState()
static WhoAmIResponseStatesEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WhoAmIResponseStatesEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

END_STATE

public static final WhoAmIResponseStatesEnum END_STATE

The END_STATE

START_STATE

public static final WhoAmIResponseStatesEnum START_STATE

start state

AUTHZ_ID_RESPONSE_STATE

public static final WhoAmIResponseStatesEnum AUTHZ_ID_RESPONSE_STATE

the authzid

LAST_WHO_AM_I_RESPONSE_STATE

public static final WhoAmIResponseStatesEnum LAST_WHO_AM_I_RESPONSE_STATE

Last state

Method Detail

values

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

Returns:

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

valueOf

public static WhoAmIResponseStatesEnum 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 WhoAmIResponseStatesEnum getStartState()

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum