Package org.apache.directory.api.ldap.extras.controls.vlv_impl

Enum VirtualListViewResponseStates

java.lang.Object

java.lang.Enum<VirtualListViewResponseStates>

org.apache.directory.api.ldap.extras.controls.vlv_impl.VirtualListViewResponseStates

All Implemented Interfaces:

Serializable, Comparable<VirtualListViewResponseStates>, States

public enum VirtualListViewResponseStates
extends Enum<VirtualListViewResponseStates>
implements States

This class store the VirtualListViewResponse grammar constants. It is also used for debugging purposes.

Author:

Apache Directory Project

Enum Constant Summary

Enum Constants

Enum Constant	Description
END_STATE	Final state
START_STATE	Initial state
VLV_CONTENT_COUNT_STATE	contentCount INTEGER (0 ..
VLV_CONTEXT_ID_STATE	contextID OCTET STRING OPTIONAL transition
VLV_SEQUENCE_STATE	VirtualListViewResponse ::= SEQUENCE transition
VLV_TARGET_POSITION_STATE	targetPosition INTEGER (0 ..
VLV_VIRTUAL_LIST_VIEW_RESULT_STATE	virtualListViewResult ENUMERATED transition

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

START_STATE

public static final VirtualListViewResponseStates START_STATE

Initial state

VLV_SEQUENCE_STATE

public static final VirtualListViewResponseStates VLV_SEQUENCE_STATE

VirtualListViewResponse ::= SEQUENCE transition

VLV_TARGET_POSITION_STATE

public static final VirtualListViewResponseStates VLV_TARGET_POSITION_STATE

targetPosition INTEGER (0 .. maxInt) transition

VLV_CONTENT_COUNT_STATE

public static final VirtualListViewResponseStates VLV_CONTENT_COUNT_STATE

contentCount INTEGER (0 .. maxInt) transition

VLV_VIRTUAL_LIST_VIEW_RESULT_STATE

public static final VirtualListViewResponseStates VLV_VIRTUAL_LIST_VIEW_RESULT_STATE

virtualListViewResult ENUMERATED transition

VLV_CONTEXT_ID_STATE

public static final VirtualListViewResponseStates VLV_CONTEXT_ID_STATE

contextID OCTET STRING OPTIONAL transition

END_STATE

public static final VirtualListViewResponseStates END_STATE

Final state

Method Detail

values

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

Returns:

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

valueOf

public static VirtualListViewResponseStates 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 Enum<?> getStartState()

Specified by:

getStartState in interface States

Returns:

The START_STATE of the enum