org.antlr.v4.runtime.atn

Class ATNState

java.lang.Object

org.antlr.v4.runtime.atn.ATNState

Direct Known Subclasses:

BasicState, BlockEndState, DecisionState, LoopEndState, RuleStartState, RuleStopState, StarLoopbackState

public abstract class ATNState
extends java.lang.Object

The following images show the relation of states and transitions for various grammar constructs.

• Solid edges marked with an ε indicate a required EpsilonTransition.
• Dashed edges indicate locations where any transition derived from Transition might appear.
• Dashed nodes are place holders for either a sequence of linked BasicState states or the inclusion of a block representing a nested construct in one of the forms below.
• Nodes showing multiple outgoing alternatives with a ... support any number of alternatives (one or more). Nodes without the ... only support the exact number of alternatives shown in the diagram.

Basic Blocks

Rule

Block of 1 or more alternatives

Greedy Loops

Greedy Closure: (...)*

Greedy Positive Closure: (...)+

Greedy Optional: (...)?

Non-Greedy Loops

Non-Greedy Closure: (...)*?

Non-Greedy Positive Closure: (...)+?

Non-Greedy Optional: (...)??

Field Summary

Fields

Modifier and Type	Field and Description
ATN	atn Which ATN are we in?
static int	BASIC
static int	BLOCK_END
static int	BLOCK_START
boolean	epsilonOnlyTransitions
static int	INITIAL_NUM_TRANSITIONS
static int	INVALID_STATE_NUMBER
static int	INVALID_TYPE
static int	LOOP_END
IntervalSet	nextTokenWithinRule Used to cache lookahead during parsing, not used during construction
static int	PLUS_BLOCK_START
static int	PLUS_LOOP_BACK
static int	RULE_START
static int	RULE_STOP
int	ruleIndex
static java.util.List<java.lang.String>	serializationNames
static int	STAR_BLOCK_START
static int	STAR_LOOP_BACK
static int	STAR_LOOP_ENTRY
int	stateNumber
static int	TOKEN_START
protected java.util.List<Transition>	transitions Track the transitions emanating from this ATN state.

Constructor Summary

Constructors

Constructor and Description
ATNState()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTransition(int index, Transition e)
void	addTransition(Transition e)
boolean	equals(java.lang.Object o)
int	getNumberOfTransitions()
abstract int	getStateType()
Transition[]	getTransitions()
int	hashCode()
boolean	isNonGreedyExitState()
boolean	onlyHasEpsilonTransitions()
Transition	removeTransition(int index)
void	setRuleIndex(int ruleIndex)
void	setTransition(int i, Transition e)
java.lang.String	toString()
Transition	transition(int i)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INITIAL_NUM_TRANSITIONS

public static final int INITIAL_NUM_TRANSITIONS

See Also:

Constant Field Values

INVALID_TYPE

public static final int INVALID_TYPE

See Also:

Constant Field Values

BASIC

public static final int BASIC

See Also:

Constant Field Values

RULE_START

public static final int RULE_START

See Also:

Constant Field Values

BLOCK_START

public static final int BLOCK_START

See Also:

Constant Field Values

PLUS_BLOCK_START

public static final int PLUS_BLOCK_START

See Also:

Constant Field Values

STAR_BLOCK_START

public static final int STAR_BLOCK_START

See Also:

Constant Field Values

TOKEN_START

public static final int TOKEN_START

See Also:

Constant Field Values

RULE_STOP

public static final int RULE_STOP

See Also:

Constant Field Values

BLOCK_END

public static final int BLOCK_END

See Also:

Constant Field Values

STAR_LOOP_BACK

public static final int STAR_LOOP_BACK

See Also:

Constant Field Values

STAR_LOOP_ENTRY

public static final int STAR_LOOP_ENTRY

See Also:

Constant Field Values

PLUS_LOOP_BACK

public static final int PLUS_LOOP_BACK

See Also:

Constant Field Values

LOOP_END

public static final int LOOP_END

See Also:

Constant Field Values

serializationNames

public static final java.util.List<java.lang.String> serializationNames

INVALID_STATE_NUMBER

public static final int INVALID_STATE_NUMBER

See Also:

Constant Field Values

atn

public ATN atn

Which ATN are we in?

stateNumber

public int stateNumber

ruleIndex

public int ruleIndex

epsilonOnlyTransitions

public boolean epsilonOnlyTransitions

transitions

protected final java.util.List<Transition> transitions

Track the transitions emanating from this ATN state.

nextTokenWithinRule

public IntervalSet nextTokenWithinRule

Used to cache lookahead during parsing, not used during construction

Constructor Detail

ATNState

public ATNState()

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

isNonGreedyExitState

public boolean isNonGreedyExitState()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTransitions

public Transition[] getTransitions()

getNumberOfTransitions

public int getNumberOfTransitions()

addTransition

public void addTransition(Transition e)

addTransition

public void addTransition(int index,
                 Transition e)

transition

public Transition transition(int i)

setTransition

public void setTransition(int i,
                 Transition e)

removeTransition

public Transition removeTransition(int index)

getStateType

public abstract int getStateType()

onlyHasEpsilonTransitions

public final boolean onlyHasEpsilonTransitions()

setRuleIndex

public void setRuleIndex(int ruleIndex)