Package org.apache.directory.api.asn1.ber.grammar

Class AbstractGrammar<C extends Asn1Container>

java.lang.Object

org.apache.directory.api.asn1.ber.grammar.AbstractGrammar<C>

Type Parameters:

C - The container type

All Implemented Interfaces:

Grammar<C>

Direct Known Subclasses:

AdDirSyncRequestGrammar, AdDirSyncResponseGrammar, AdPolicyHintsGrammar, CancelRequestGrammar, CertGenerationRequestGrammar, ControlsGrammar, EndTransactionRequestGrammar, EndTransactionResponseGrammar, EntryChangeGrammar, GracefulDisconnectResponseGrammar, GracefulShutdownRequestGrammar, LdapMessageGrammar, PagedResultsGrammar, PasswordModifyRequestGrammar, PasswordModifyResponseGrammar, PasswordPolicyResponseGrammar, PersistentSearchGrammar, SortRequestGrammar, SortResponseGrammar, StoredProcedureRequestGrammar, SubentriesGrammar, SyncDoneValueGrammar, SyncInfoValueGrammar, SyncRequestValueGrammar, SyncStateValueGrammar, VirtualListViewRequestGrammar, VirtualListViewResponseGrammar

public abstract class AbstractGrammar<C extends Asn1Container>
extends Object
implements Grammar<C>

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()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	executeAction(C container)	This method, when called, execute an action on the current data stored in the container.
String	getName()	Get the grammar name
GrammarTransition<C>	getTransition(Enum<?> state, int tag)	Get the transition associated with the state and tag
void	setName(String name)	Set the grammar's name

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractGrammar

public AbstractGrammar()

Default constructor

Method Detail

getName

public String getName()

Get the grammar name

Specified by:

getName in interface Grammar<C extends Asn1Container>

Returns:

Return the grammar's name

setName

public void setName(String name)

Set the grammar's name

Specified by:

setName in interface Grammar<C extends Asn1Container>

Parameters:

name - The grammar name

getTransition

public GrammarTransition<C> getTransition(Enum<?> state,
                                          int tag)

Get the transition associated with the state and tag

Parameters:

state - The current state

tag - The current tag

Returns:

A valid transition if any, or null.

executeAction

public void executeAction(C container)
                   throws DecoderException

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

Specified by:

executeAction in interface Grammar<C extends Asn1Container>

Parameters:

container - Store the data being processed.

Throws:

DecoderException - Thrown when an unrecoverable error occurs.