Grammar (org.apache.directory.api_api-all_sources-and-javadoc 2.1.1 API)

All Known Implementing Classes:

AbstractGrammar, Dsmlv2Grammar, Dsmlv2ResponseGrammar
```
public interface Grammar
```
The interface which expose common behavior of a Grammar implementer.

Author:

Apache Directory Project

Method Summary

All Methods Instance Methods Abstract 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()`	Get the grammar name
`Enum<Dsmlv2StatesEnum>[]`	`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 XmlPullParserException,
                   IOException
```
    This method, when called, executes an action on the current data stored in the container.
    
    Parameters:
    
    container - the DSML container
    
    Throws:
    
    XmlPullParserException - when an unrecoverable error occurs
    
    IOException - when an IO error occurs
  - getName
```
String getName()
```
    Get the grammar name
    
    Returns:
    
    Return the grammar's name
  - getStatesEnum
```
Enum<Dsmlv2StatesEnum>[] 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