org.apache.directory.api.dsmlv2

Interface Grammar

All Known Implementing Classes:

AbstractGrammar, Dsmlv2Grammar, Dsmlv2ResponseGrammar

public interface Grammar

The interface which expose common behavior of a Grammar implementer.

Method Summary

Modifier and Type	Method and Description
void	executeAction(Dsmlv2Container container) This method, when called, executes an action on the current data stored in the container.
java.lang.String	getName() Get the grammar name
java.lang.Enum<Dsmlv2StatesEnum>[]	getStatesEnum() Get the statesEnum for the current grammar
void	setName(java.lang.String name) Set the grammar's name

Method Detail

executeAction

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

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

Parameters:

container - the DSML container

Throws:

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

java.io.IOException - when an IO error occurs

getName

java.lang.String getName()

Get the grammar name

Returns:

Return the grammar's name

getStatesEnum

java.lang.Enum<Dsmlv2StatesEnum>[] getStatesEnum()

Get the statesEnum for the current grammar

Returns:

The specific States Enum for the current grammar

setName

void setName(java.lang.String name)

Set the grammar's name

Parameters:

name - The grammar name