org.apache.directory.shared.asn1.ber.grammar

Interface IGrammar

All Known Implementing Classes:

AbstractGrammar, CancelGrammar, CertGenerationGrammar, EntryChangeControlGrammar, GracefulDisconnectGrammar, GracefulShutdownGrammar, LdapMessageGrammar, PagedResultsControlGrammar, PersistentSearchControlGrammar, StoredProcedureGrammar, SubentriesControlGrammar, SyncDoneValueControlGrammar, SyncInfoValueControlGrammar, SyncRequestValueControlGrammar, SyncStateValueControlGrammar

public interface IGrammar

The interface which expose common behavior of a Gramar implementer.

Version:

$Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200(sab, 07 giu 2008) $

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
void	executeAction(IAsn1Container asn1Container) 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(IAsn1Container asn1Container)
            throws DecoderException

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

Parameters:

asn1Container - Store the data being processed.

Throws:

DecoderException - Thrown when an unrecoverable error occurs.

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