org.apache.directory.shared.ldap.extras.controls.syncrepl_impl
Enum SyncModifyDnStatesEnum

java.lang.Object
  extended by java.lang.Enum<SyncModifyDnStatesEnum>
      extended by org.apache.directory.shared.ldap.extras.controls.syncrepl_impl.SyncModifyDnStatesEnum
All Implemented Interfaces:
Serializable, Comparable<SyncModifyDnStatesEnum>, States

public enum SyncModifyDnStatesEnum
extends Enum<SyncModifyDnStatesEnum>
implements States

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

Author:
Apache Directory Project

Enum Constant Summary
END_STATE
          The END_STATE
ENTRY_DN_STATE
          modDn control's entryDN
LAST_SYNC_MODDN_VALUE_STATE
          terminal state
MOVE_AND_RENAME_DEL_OLD_RDN_STATE
          modDn control's move and rename deleteOldRdn flag
MOVE_AND_RENAME_NEW_RDN_STATE
          modDn control's move and rename newRDN
MOVE_AND_RENAME_NEW_SUPERIOR_DN_STATE
          modDn control's move and rename newSuperiorDN
MOVE_AND_RENAME_STATE
          modDn rename sequence
MOVE_STATE
          modDn control's move operation state
RENAME_DEL_OLD_RDN_STATE
          modDn control's rename deleteOldRdn flag
RENAME_NEW_RDN_STATE
          modDn control's rename newRDN
RENAME_STATE
          modDn rename sequence
START_SYNC_MODDN
          Initial state
SYNC_MODDN_VALUE_SEQUENCE_STATE
          Sequence Value
 
Method Summary
 String getGrammarName(Grammar grammar)
          Get the grammar name
 String getGrammarName(int grammar)
          Get the grammar name
 SyncModifyDnStatesEnum getStartState()
          
 String getState(int state)
          Get the string representing the state
 boolean isEndState()
          
static SyncModifyDnStatesEnum valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SyncModifyDnStatesEnum[] 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 SyncModifyDnStatesEnum END_STATE
The END_STATE


START_SYNC_MODDN

public static final SyncModifyDnStatesEnum START_SYNC_MODDN
Initial state


SYNC_MODDN_VALUE_SEQUENCE_STATE

public static final SyncModifyDnStatesEnum SYNC_MODDN_VALUE_SEQUENCE_STATE
Sequence Value


ENTRY_DN_STATE

public static final SyncModifyDnStatesEnum ENTRY_DN_STATE
modDn control's entryDN


MOVE_STATE

public static final SyncModifyDnStatesEnum MOVE_STATE
modDn control's move operation state


RENAME_STATE

public static final SyncModifyDnStatesEnum RENAME_STATE
modDn rename sequence


MOVE_AND_RENAME_STATE

public static final SyncModifyDnStatesEnum MOVE_AND_RENAME_STATE
modDn rename sequence


RENAME_NEW_RDN_STATE

public static final SyncModifyDnStatesEnum RENAME_NEW_RDN_STATE
modDn control's rename newRDN


RENAME_DEL_OLD_RDN_STATE

public static final SyncModifyDnStatesEnum RENAME_DEL_OLD_RDN_STATE
modDn control's rename deleteOldRdn flag


MOVE_AND_RENAME_NEW_SUPERIOR_DN_STATE

public static final SyncModifyDnStatesEnum MOVE_AND_RENAME_NEW_SUPERIOR_DN_STATE
modDn control's move and rename newSuperiorDN


MOVE_AND_RENAME_NEW_RDN_STATE

public static final SyncModifyDnStatesEnum MOVE_AND_RENAME_NEW_RDN_STATE
modDn control's move and rename newRDN


MOVE_AND_RENAME_DEL_OLD_RDN_STATE

public static final SyncModifyDnStatesEnum MOVE_AND_RENAME_DEL_OLD_RDN_STATE
modDn control's move and rename deleteOldRdn flag


LAST_SYNC_MODDN_VALUE_STATE

public static final SyncModifyDnStatesEnum LAST_SYNC_MODDN_VALUE_STATE
terminal state

Method Detail

values

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

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

valueOf

public static SyncModifyDnStatesEnum 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(int grammar)
Get the grammar name

Parameters:
grammar - The grammar code
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 SyncModifyDnStatesEnum getStartState()

Specified by:
getStartState in interface States


Copyright © 2003-2011 The Apache Software Foundation. All Rights Reserved.