org.apache.directory.shared.ldap.codec.search.controls
Class PSearchControlStatesEnum

java.lang.Object
  extended byorg.apache.directory.shared.ldap.codec.search.controls.PSearchControlStatesEnum
All Implemented Interfaces:
org.apache.directory.shared.asn1.ber.grammar.IStates

public class PSearchControlStatesEnum
extends java.lang.Object
implements org.apache.directory.shared.asn1.ber.grammar.IStates

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

Author:
Apache Directory Project

Field Summary
static int CHANGE_TYPES_TAG
          changeTypes Tag
static int CHANGE_TYPES_VALUE
          changeTypes Value
static int CHANGES_ONLY_TAG
          changesOnly Tag
static int CHANGES_ONLY_VALUE
          changesOnly Value
static int LAST_PSEARCH_STATE
          terminal state
static int NB_GRAMMARS
          The total number of grammars used
static int PSEARCH_GRAMMAR
          PSearch grammar number
static int PSEARCH_GRAMMAR_SWITCH
          PSsearch grammar
static int PSEARCH_SEQUENCE_TAG
          Sequence Tag
static int PSEARCH_SEQUENCE_VALUE
          Sequence Value
static int RETURN_ECS_TAG
          returnECs Tag
static int RETURN_ECS_VALUE
          returnECs Value
 
Fields inherited from interface org.apache.directory.shared.asn1.ber.grammar.IStates
END_STATE, GRAMMAR_END, GRAMMAR_SWITCH_MASK, INIT_GRAMMAR_STATE, STATES_SWITCH_MASK
 
Method Summary
 java.lang.String getGrammarName(org.apache.directory.shared.asn1.ber.grammar.IGrammar grammar)
          Get the grammar name
 java.lang.String getGrammarName(int grammar)
          Get the grammar name
static org.apache.directory.shared.asn1.ber.grammar.IStates getInstance()
          Get an instance of this class
 java.lang.String getState(int grammar, int state)
          Get the string representing the state
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PSEARCH_SEQUENCE_TAG

public static int PSEARCH_SEQUENCE_TAG
Sequence Tag


PSEARCH_SEQUENCE_VALUE

public static int PSEARCH_SEQUENCE_VALUE
Sequence Value


CHANGE_TYPES_TAG

public static int CHANGE_TYPES_TAG
changeTypes Tag


CHANGE_TYPES_VALUE

public static int CHANGE_TYPES_VALUE
changeTypes Value


CHANGES_ONLY_TAG

public static int CHANGES_ONLY_TAG
changesOnly Tag


CHANGES_ONLY_VALUE

public static int CHANGES_ONLY_VALUE
changesOnly Value


RETURN_ECS_TAG

public static int RETURN_ECS_TAG
returnECs Tag


RETURN_ECS_VALUE

public static int RETURN_ECS_VALUE
returnECs Value


LAST_PSEARCH_STATE

public static int LAST_PSEARCH_STATE
terminal state


PSEARCH_GRAMMAR_SWITCH

public static final int PSEARCH_GRAMMAR_SWITCH
PSsearch grammar

See Also:
Constant Field Values

PSEARCH_GRAMMAR

public static final int PSEARCH_GRAMMAR
PSearch grammar number

See Also:
Constant Field Values

NB_GRAMMARS

public static final int NB_GRAMMARS
The total number of grammars used

See Also:
Constant Field Values
Method Detail

getInstance

public static org.apache.directory.shared.asn1.ber.grammar.IStates getInstance()
Get an instance of this class

Returns:
An instance on this class

getGrammarName

public java.lang.String getGrammarName(int grammar)
Get the grammar name

Specified by:
getGrammarName in interface org.apache.directory.shared.asn1.ber.grammar.IStates
Parameters:
grammar - The grammar code
Returns:
The grammar name

getGrammarName

public java.lang.String getGrammarName(org.apache.directory.shared.asn1.ber.grammar.IGrammar grammar)
Get the grammar name

Specified by:
getGrammarName in interface org.apache.directory.shared.asn1.ber.grammar.IStates
Parameters:
grammar - The grammar class
Returns:
The grammar name

getState

public java.lang.String getState(int grammar,
                                 int state)
Get the string representing the state

Specified by:
getState in interface org.apache.directory.shared.asn1.ber.grammar.IStates
Parameters:
grammar - The current grammar being used
state - The state number
Returns:
The String representing the state


Copyright © 2003-2006 . All Rights Reserved.