ANTLR 4 Runtime (Optimized) 4.9.0 · org.antlr.v4.runtime.atn.ATNState

The following images show the relation of states and ATNState#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

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

Constructor Summary

Access	Constructor and Description
public	ATNState()

Method Summary

Modifier and Type	Method and Description
public void	addOptimizedTransition(Transition e)
public void	addTransition(Transition e)
public void	addTransition(int index, Transition e)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	Returns: -1 for `RuleStopState`, otherwise the state number getNonStopStateNumber() For all states except `RuleStopState`, this returns the state number.
public int	getNumberOfOptimizedTransitions()
public int	getNumberOfTransitions()
public Transition	getOptimizedTransition(int i)
public final int	Returns: the state number getStateNumber() Gets the state number.
public abstract int	getStateType()
public Transition[]	getTransitions()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isNonGreedyExitState()
public boolean	isOptimized()
public final boolean	onlyHasEpsilonTransitions()
public void	removeOptimizedTransition(int i)
public Transition	removeTransition(int index)
public void	setOptimizedTransition(int i, Transition e)
public void	setRuleIndex(int ruleIndex)
public void	setTransition(int i, Transition e)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Transition	transition(int i)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

atn	back to summary
public ATN atn Which ATN are we in?

BASIC	back to summary
public static final int BASIC

BLOCK_END	back to summary
public static final int BLOCK_END

BLOCK_START	back to summary
public static final int BLOCK_START

epsilonOnlyTransitions	back to summary
public boolean epsilonOnlyTransitions

INITIAL_NUM_TRANSITIONS	back to summary
public static final int INITIAL_NUM_TRANSITIONS

INVALID_STATE_NUMBER	back to summary
public static final int INVALID_STATE_NUMBER

INVALID_TYPE	back to summary
public static final int INVALID_TYPE

LOOP_END	back to summary
public static final int LOOP_END

nextTokenWithinRule	back to summary
public IntervalSet nextTokenWithinRule Used to cache lookahead during parsing, not used during construction

optimizedTransitions	back to summary
protected List<Transition> optimizedTransitions

PLUS_BLOCK_START	back to summary
public static final int PLUS_BLOCK_START

PLUS_LOOP_BACK	back to summary
public static final int PLUS_LOOP_BACK

RULE_START	back to summary
public static final int RULE_START

RULE_STOP	back to summary
public static final int RULE_STOP

ruleIndex	back to summary
public int ruleIndex

serializationNames	back to summary
public static final List<String> serializationNames

STAR_BLOCK_START	back to summary
public static final int STAR_BLOCK_START

STAR_LOOP_BACK	back to summary
public static final int STAR_LOOP_BACK

STAR_LOOP_ENTRY	back to summary
public static final int STAR_LOOP_ENTRY

stateNumber	back to summary
public int stateNumber

TOKEN_START	back to summary
public static final int TOKEN_START

transitions	back to summary
protected final List<Transition> transitions Track the transitions emanating from this ATN state.

Constructor Detail

ATNState	back to summary
public ATNState()

Method Detail

addOptimizedTransition	back to summary
public void addOptimizedTransition(Transition e)

addTransition	back to summary
public void addTransition(Transition e)

addTransition	back to summary
public void addTransition(int index, Transition e)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getNonStopStateNumber back to summary

getNonStopStateNumber	back to summary
public int getNonStopStateNumber() For all states except `RuleStopState`, this returns the state number. Returns -1 for stop states. Returns:int -1 for `RuleStopState`, otherwise the state number

public int getNonStopStateNumber()

For all states except RuleStopState, this returns the state number. Returns -1 for stop states.

Returns:int: -1 for RuleStopState, otherwise the state number

getNumberOfOptimizedTransitions	back to summary
public int getNumberOfOptimizedTransitions()

getNumberOfTransitions	back to summary
public int getNumberOfTransitions()

getOptimizedTransition	back to summary
public Transition getOptimizedTransition(int i)

getStateNumber	back to summary
public final int getStateNumber() Gets the state number. Returns:int the state number

getStateNumber

back to summary

public final int getStateNumber()

Gets the state number.

Returns:int: the state number

getStateType	back to summary
public abstract int getStateType()

getTransitions	back to summary
public Transition[] getTransitions()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isNonGreedyExitState	back to summary
public boolean isNonGreedyExitState()

isOptimized	back to summary
public boolean isOptimized()

onlyHasEpsilonTransitions	back to summary
public final boolean onlyHasEpsilonTransitions()

removeOptimizedTransition	back to summary
public void removeOptimizedTransition(int i)

removeTransition	back to summary
public Transition removeTransition(int index)

setOptimizedTransition	back to summary
public void setOptimizedTransition(int i, Transition e)

setRuleIndex	back to summary
public void setRuleIndex(int ruleIndex)

setTransition	back to summary
public void setTransition(int i, Transition e)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

transition	back to summary
public Transition transition(int i)

public abstract Class ATNState

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

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Greedy Closure: `(...)*`

Greedy Positive Closure: `(...)+`

Greedy Optional: `(...)?`

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

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

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