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

Class AbstractGrammar<C extends Asn1Container>

java.lang.Object

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

All Implemented Interfaces:

Grammar<C>

Direct Known Subclasses:

AdDirSyncGrammar, CancelGrammar, CertGenerationGrammar, EntryChangeGrammar, GracefulDisconnectGrammar, GracefulShutdownGrammar, LdapMessageGrammar, PagedResultsGrammar, PasswordModifyRequestGrammar, PasswordModifyResponseGrammar, PasswordPolicyGrammar, PersistentSearchGrammar, SortRequestGrammar, SortResponseGrammar, StoredProcedureGrammar, SubentriesGrammar, SyncDoneValueGrammar, SyncInfoValueGrammar, SyncRequestValueGrammar, SyncStateValueGrammar, VirtualListViewRequestGrammar, VirtualListViewResponseGrammar, WhoAmIResponseGrammar

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

The abstract Grammar which is the Mother of all the grammars. It contains the transitions table.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG The logger
private java.lang.String	name The grammar name
protected GrammarTransition<C>[][]	transitions Table of transitions.

Constructor Summary

Constructors

Constructor and Description
AbstractGrammar() Default constructor

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

transitions

protected GrammarTransition<C extends Asn1Container>[][] transitions

Table of transitions. It's a two dimension array, the first dimension indices the states, the second dimension indices the Tag value, so it is 256 wide.

name

private java.lang.String name

The grammar name

Constructor Detail

AbstractGrammar

public AbstractGrammar()

Default constructor

Method Detail

getName

public java.lang.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(java.lang.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(java.lang.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.