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

Modifier and Type	Field and Description
protected ATNInterpreter	_interp
private List<ANTLRErrorListener<? super Symbol>>	_listeners
private int	_stateNumber
public static final int	EOF
private static final Map<String[], Map<String, Integer>>	ruleIndexMapCache
private static final Map<Vocabulary, Map<String, Integer>>	tokenTypeMapCache

Access	Constructor and Description
public	Recognizer()

Method Summary

Modifier and Type	Method and Description
public void	action(RuleContext _localctx, int ruleIndex, int actionIndex)
public void	addErrorListener(ANTLRErrorListener<? super Symbol> listener)
public ATN	Returns: The `ATN` used by the recognizer for prediction. getATN() Get the `ATN` used by the recognizer for prediction.
public String	getErrorHeader(RecognitionException e) What is the error header, normally line/character position information?
public ANTLRErrorListener<? super Symbol>	getErrorListenerDispatch()
public List<? extends ANTLRErrorListener<? super Symbol>>	getErrorListeners()
public abstract String	getGrammarFileName() For debugging and other purposes, might want the grammar name.
public abstract IntStream	getInputStream()
public ATNInterpreter	Returns: The ATN interpreter used by the recognizer for prediction. getInterpreter() Get the ATN interpreter used by the recognizer for prediction.
public ParseInfo	getParseInfo() If profiling during the parse/lex, this will return DecisionInfo records for each decision in recognizer in a ParseInfo object.
public Map<String, Integer>	getRuleIndexMap() Get a map from rule names to rule indexes.
public abstract String[]	getRuleNames()
public String	getSerializedATN() If this recognizer was generated, it will have a serialized ATN representation of the grammar.
public final int	getState()
public String	getTokenErrorDisplay(Token t) Deprecated This method is not called by the ANTLR 4 Runtime. How should a token be displayed in an error message?
public abstract String[]	getTokenNames() Deprecated Use `getVocabulary()` instead. Used to print out token names like ID during debugging and error reporting.
public int	getTokenType(String tokenName)
public Map<String, Integer>	getTokenTypeMap() Get a map from token names to token types.
public Vocabulary	Returns: A `Vocabulary` instance providing information about the vocabulary used by the grammar. getVocabulary() Get the vocabulary used by the recognizer.
public boolean	precpred(RuleContext localctx, int precedence)
public void	removeErrorListener(ANTLRErrorListener<? super Symbol> listener)
public void	removeErrorListeners()
public boolean	sempred(RuleContext _localctx, int ruleIndex, int actionIndex)
public void	setInterpreter(ATNInterpreter The ATN interpreter used by the recognizer for prediction. interpreter) Set the ATN interpreter used by the recognizer for prediction.
public final void	setState(int atnState) Indicate that the recognizer has changed internal state that is consistent with the ATN state passed in. This way we always know where we are in the ATN as the parser goes along.

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

_interp	back to summary
protected ATNInterpreter _interp

_listeners	back to summary
private List<ANTLRErrorListener<? super Symbol>> _listeners Annotations @SuppressWarnings:serial @NotNull

_stateNumber	back to summary
private int _stateNumber

EOF	back to summary
public static final int EOF

ruleIndexMapCache	back to summary
private static final Map<String[], Map<String, Integer>> ruleIndexMapCache

tokenTypeMapCache	back to summary
private static final Map<Vocabulary, Map<String, Integer>> tokenTypeMapCache

Recognizer	back to summary
public Recognizer()

Method Detail

action	back to summary
public void action(RuleContext _localctx, int ruleIndex, int actionIndex)

addErrorListener	back to summary
public void addErrorListener(ANTLRErrorListener<? super Symbol> listener) Exceptions NullPointerException: if `listener` is `null`.

getATN back to summary

getATN	back to summary
public ATN getATN() Get the `ATN` used by the recognizer for prediction. Returns:ATN The `ATN` used by the recognizer for prediction. Annotations @NotNull

public ATN getATN()

Get the ATN used by the recognizer for prediction.

Returns:ATN

The ATN used by the recognizer for prediction.

Annotations

@NotNull

getErrorHeader	back to summary
public String getErrorHeader(RecognitionException e) What is the error header, normally line/character position information? Annotations @NotNull

getErrorHeader

back to summary

public String getErrorHeader(RecognitionException e)

What is the error header, normally line/character position information?

Annotations

@NotNull

getErrorListenerDispatch	back to summary
public ANTLRErrorListener<? super Symbol> getErrorListenerDispatch()

getErrorListeners	back to summary
public List<? extends ANTLRErrorListener<? super Symbol>> getErrorListeners() Annotations @NotNull

getGrammarFileName	back to summary
public abstract String getGrammarFileName() For debugging and other purposes, might want the grammar name. Have ANTLR generate an implementation for this method.

getInputStream	back to summary
public abstract IntStream getInputStream()

getInterpreter	back to summary
public ATNInterpreter getInterpreter() Get the ATN interpreter used by the recognizer for prediction. Returns:ATNInterpreter The ATN interpreter used by the recognizer for prediction. Annotations @NotNull

getInterpreter

back to summary

public ATNInterpreter getInterpreter()

Get the ATN interpreter used by the recognizer for prediction.

Returns:ATNInterpreter

The ATN interpreter used by the recognizer for prediction.

Annotations

@NotNull

getParseInfo	back to summary
public ParseInfo getParseInfo() If profiling during the parse/lex, this will return DecisionInfo records for each decision in recognizer in a ParseInfo object. Since 4.3

getParseInfo

back to summary

public ParseInfo getParseInfo()

If profiling during the parse/lex, this will return DecisionInfo records for each decision in recognizer in a ParseInfo object.

Since: 4.3

getRuleIndexMap	back to summary
public Map<String, Integer> getRuleIndexMap() Get a map from rule names to rule indexes. Used for XPath and tree pattern compilation. Annotations @NotNull

getRuleIndexMap

back to summary

public Map<String, Integer> getRuleIndexMap()

Get a map from rule names to rule indexes.

Used for XPath and tree pattern compilation.

Annotations

@NotNull

getRuleNames	back to summary
public abstract String[] getRuleNames()

getSerializedATN	back to summary
public String getSerializedATN() If this recognizer was generated, it will have a serialized ATN representation of the grammar. For interpreters, we don't know their serialized ATN despite having created the interpreter from it. Annotations @NotNull

getSerializedATN

back to summary

public String getSerializedATN()

If this recognizer was generated, it will have a serialized ATN representation of the grammar.

For interpreters, we don't know their serialized ATN despite having created the interpreter from it.

Annotations

@NotNull

getState	back to summary
public final int getState()

getTokenErrorDisplay back to summary

getTokenErrorDisplay	back to summary
public String getTokenErrorDisplay(Token t) Deprecated This method is not called by the ANTLR 4 Runtime. Specific implementations of `ANTLRErrorStrategy` may provide a similar feature when necessary. For example, see `DefaultErrorStrategy#getTokenErrorDisplay`. How should a token be displayed in an error message? The default is to display just the text, but during development you might want to have a lot of information spit out. Override in that case to use t.toString() (which, for CommonToken, dumps everything about the token). This is better than forcing you to override a method in your token objects because you don't have to go modify your lexer so that it creates a new Java type. Annotations @Deprecated

public String getTokenErrorDisplay(Token t)

Deprecated

This method is not called by the ANTLR 4 Runtime. Specific implementations of ANTLRErrorStrategy may provide a similar feature when necessary. For example, see DefaultErrorStrategy#getTokenErrorDisplay.

How should a token be displayed in an error message? The default is to display just the text, but during development you might want to have a lot of information spit out. Override in that case to use t.toString() (which, for CommonToken, dumps everything about the token). This is better than forcing you to override a method in your token objects because you don't have to go modify your lexer so that it creates a new Java type.

Annotations

@Deprecated

getTokenNames back to summary

getTokenNames	back to summary
public abstract String[] getTokenNames() Deprecated Use `getVocabulary()` instead. Used to print out token names like ID during debugging and error reporting. The generated parsers implement a method that overrides this to point to their String[] tokenNames. Annotations @Deprecated

public abstract String[] getTokenNames()

Deprecated

Use getVocabulary() instead.

Used to print out token names like ID during debugging and error reporting. The generated parsers implement a method that overrides this to point to their String[] tokenNames.

Annotations

@Deprecated

getTokenType	back to summary
public int getTokenType(String tokenName)

getTokenTypeMap	back to summary
public Map<String, Integer> getTokenTypeMap() Get a map from token names to token types. Used for XPath and tree pattern compilation. Annotations @NotNull

getTokenTypeMap

back to summary

public Map<String, Integer> getTokenTypeMap()

Get a map from token names to token types.

Used for XPath and tree pattern compilation.

Annotations

@NotNull

getVocabulary back to summary

getVocabulary	back to summary
public Vocabulary getVocabulary() Get the vocabulary used by the recognizer. Returns:Vocabulary A `Vocabulary` instance providing information about the vocabulary used by the grammar. Annotations @NotNull @SuppressWarnings:deprecation

public Vocabulary getVocabulary()

Get the vocabulary used by the recognizer.

Returns:Vocabulary

A Vocabulary instance providing information about the vocabulary used by the grammar.

Annotations

@NotNull
@SuppressWarnings:deprecation

precpred	back to summary
public boolean precpred(RuleContext localctx, int precedence)

removeErrorListener	back to summary
public void removeErrorListener(ANTLRErrorListener<? super Symbol> listener)

removeErrorListeners	back to summary
public void removeErrorListeners()

sempred	back to summary
public boolean sempred(RuleContext _localctx, int ruleIndex, int actionIndex)

setInterpreter	back to summary
public void setInterpreter(ATNInterpreter interpreter) Set the ATN interpreter used by the recognizer for prediction. Parameters interpreter:ATNInterpreter The ATN interpreter used by the recognizer for prediction.

setInterpreter

back to summary

public void setInterpreter(ATNInterpreter interpreter)

Set the ATN interpreter used by the recognizer for prediction.

Parameters

interpreter:ATNInterpreter: The ATN interpreter used by the recognizer for prediction.

setState	back to summary
public final void setState(int atnState) Indicate that the recognizer has changed internal state that is consistent with the ATN state passed in. This way we always know where we are in the ATN as the parser goes along. The rule context objects form a stack that lets us see the stack of invoking rules. Combine this and we have complete ATN configuration information.

public abstract Class Recognizer<Symbol, ATNInterpreter extends org.antlr.v4.runtime.atn.ATNSimulator>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail