org.apache.directory.shared.dsmlv2

Interface IGrammar

All Known Implementing Classes:

AbstractGrammar, Dsmlv2Grammar, Dsmlv2ResponseGrammar

public interface IGrammar

The interface which expose common behavior of a Gramar implementer.

Method Summary

Modifier and Type	Method and Description
void	executeAction(Dsmlv2Container container) This method, when called, execute an action on the current data stored in the container.
String	getName() Get the grammar name
IStates	getStatesEnum() Get the statesEnum for the current grammar
void	setName(String name) Set the grammar's name

Method Detail

executeAction

void executeAction(Dsmlv2Container container)
            throws org.xmlpull.v1.XmlPullParserException,
                   IOException

This method, when called, execute an action on the current data stored in the container.

Parameters:

container - the DSML container

Throws:

org.xmlpull.v1.XmlPullParserException - Thrown when an unrecoverable error occurs.

IOException

getName

String getName()

Get the grammar name

Returns:

Return the grammar's name

getStatesEnum

IStates getStatesEnum()

Get the statesEnum for the current grammar

Returns:

The specific States Enum for the current grammar

setName

void setName(String name)

Set the grammar's name

Parameters:

name - The grammar name