Package org.apache.directory.api.dsmlv2
Class AbstractGrammar
- java.lang.Object
-
- org.apache.directory.api.dsmlv2.AbstractGrammar
-
- All Implemented Interfaces:
Grammar
- Direct Known Subclasses:
Dsmlv2Grammar
,Dsmlv2ResponseGrammar
public abstract class AbstractGrammar extends Object implements Grammar
The abstract Grammar which is the Mother of all the grammars. It contains the transitions table.- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description AbstractGrammar()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
executeAction(Dsmlv2Container container)
This method, when called, executes an action on the current data stored in the container.String
getName()
Returns the grammar's nameEnum<Dsmlv2StatesEnum>[]
getStatesEnum()
Gets the states of the current grammarGrammarTransition
getTransition(Enum<Dsmlv2StatesEnum> state, Tag tag)
Gets the transition associated with the state and tagvoid
setName(String name)
Sets the grammar's name
-
-
-
Constructor Detail
-
AbstractGrammar
public AbstractGrammar()
-
-
Method Detail
-
getTransition
public GrammarTransition getTransition(Enum<Dsmlv2StatesEnum> state, Tag tag)
Gets the transition associated with the state and tag- Parameters:
state
- The current statetag
- The current tag- Returns:
- A valid transition if any, or null.
-
getStatesEnum
public Enum<Dsmlv2StatesEnum>[] getStatesEnum()
Gets the states of the current grammar- Specified by:
getStatesEnum
in interfaceGrammar
- Returns:
- Returns the statesEnum.
-
executeAction
public void executeAction(Dsmlv2Container container) throws org.xmlpull.v1.XmlPullParserException, IOException
This method, when called, executes an action on the current data stored in the container.- Specified by:
executeAction
in interfaceGrammar
- Parameters:
container
- the DSML container- Throws:
org.xmlpull.v1.XmlPullParserException
- when an unrecoverable error occursIOException
- when an IO error occurs
-
-