org.apache.directory.shared.ldap.codec.controls.search.entryChange
Enum EntryChangeStates

java.lang.Object
  java.lang.Enum<EntryChangeStates>
      org.apache.directory.shared.ldap.codec.controls.search.entryChange.EntryChangeStates

All Implemented Interfaces:

Serializable, Comparable<EntryChangeStates>, States

public enum EntryChangeStates
extends Enum<EntryChangeStates>
implements States

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

Author:

Apache Directory Project

Enum Constant Summary

CHANGE_NUMBER_STATE
changeNumber

CHANGE_TYPE_STATE
changeType

EC_SEQUENCE_STATE
Sequence

END_STATE
The END_STATE

LAST_EC_STATE
terminal state

PREVIOUS_DN_STATE
previousDN

START_STATE
Sequence Tag

Method Summary

String	getGrammarName() Get the grammar name
String	getGrammarName(Grammar grammar) Get the grammar name
EntryChangeStates	getStartState()
String	getState(int state) Get the string representing the state
boolean	isEndState()
static EntryChangeStates	valueOf(String name) Returns the enum constant of this type with the specified name.
static EntryChangeStates[]	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

END_STATE

public static final EntryChangeStates END_STATE

The END_STATE

START_STATE

public static final EntryChangeStates START_STATE

Sequence Tag

EC_SEQUENCE_STATE

public static final EntryChangeStates EC_SEQUENCE_STATE

Sequence

CHANGE_TYPE_STATE

public static final EntryChangeStates CHANGE_TYPE_STATE

changeType

PREVIOUS_DN_STATE

public static final EntryChangeStates PREVIOUS_DN_STATE

previousDN

CHANGE_NUMBER_STATE

public static final EntryChangeStates CHANGE_NUMBER_STATE

changeNumber

LAST_EC_STATE

public static final EntryChangeStates LAST_EC_STATE

terminal state

Method Detail

values

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

Returns:

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

valueOf

public static EntryChangeStates 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

getGrammarName

public String getGrammarName(Grammar grammar)

Get the grammar name

Parameters:

grammar - The grammar class

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

getStartState

public EntryChangeStates getStartState()

Specified by:

getStartState in interface States