org.apache.directory.api.dsmlv2

Class GrammarTransition

java.lang.Object

org.apache.directory.api.dsmlv2.GrammarTransition

public class GrammarTransition
extends java.lang.Object

Define a transition between two states of a grammar. It stores the next state, and the action to execute while transiting.

Field Summary

Fields

Modifier and Type	Field and Description
private GrammarAction	action The action associated to the transition
private java.lang.Enum<Dsmlv2StatesEnum>	currentState The current state
private java.lang.Enum<Dsmlv2StatesEnum>	nextState The next state in the grammar

Constructor Summary

Constructors

Constructor and Description
GrammarTransition(java.lang.Enum<Dsmlv2StatesEnum> currentState, java.lang.Enum<Dsmlv2StatesEnum> nextState, GrammarAction action) Creates a new GrammarTransition object.

Method Summary

Modifier and Type	Method and Description
GrammarAction	getAction() Gets the action associated with the transition
java.lang.Enum<Dsmlv2StatesEnum>	getNextState() Gets the target state
boolean	hasAction() Tells if the transition has an associated action.
java.lang.String	toString(int grammar, java.lang.Enum<Dsmlv2StatesEnum> statesEnum) Returns a representation of the transition as a string

Methods inherited from class java.lang.Object

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

Field Detail

nextState

private java.lang.Enum<Dsmlv2StatesEnum> nextState

The next state in the grammar

action

private GrammarAction action

The action associated to the transition

currentState

private java.lang.Enum<Dsmlv2StatesEnum> currentState

The current state

Constructor Detail

GrammarTransition

public GrammarTransition(java.lang.Enum<Dsmlv2StatesEnum> currentState,
                         java.lang.Enum<Dsmlv2StatesEnum> nextState,
                         GrammarAction action)

Creates a new GrammarTransition object.

Parameters:

currentState - The current transition

nextState - The target state

action - The action to execute. It could be null.

Method Detail

getNextState

public java.lang.Enum<Dsmlv2StatesEnum> getNextState()

Gets the target state

Returns:

the target state.

hasAction

public boolean hasAction()

Tells if the transition has an associated action.

Returns:

true if an action has been associated to the transition

getAction

public GrammarAction getAction()

Gets the action associated with the transition

Returns:

the action associated with the transition

toString

public java.lang.String toString(int grammar,
                                 java.lang.Enum<Dsmlv2StatesEnum> statesEnum)

Returns a representation of the transition as a string

Parameters:

grammar - the grammar which state we want a String from

statesEnum - the states enum that contains the states' names

Returns:

a representation of the transition as a string.