Uses of Interface
org.antlr.v4.runtime.Token

Packages that use Token

Package	Description
org.antlr.v4.runtime
org.antlr.v4.runtime.tree
org.antlr.v4.runtime.tree.pattern
org.antlr.v4.runtime.tree.xpath

Uses of Token in org.antlr.v4.runtime

Subinterfaces of Token in org.antlr.v4.runtime

Modifier and Type	Interface and Description
interface	WritableToken

Classes in org.antlr.v4.runtime that implement Token

Modifier and Type	Class and Description
class	CommonToken

Fields in org.antlr.v4.runtime declared as Token

Modifier and Type	Field and Description
Token	Lexer._token The goal of all lexer rules/methods is to create a token object.
protected Token	ListTokenSource.eofToken This field caches the EOF token for the token source.
protected Token	UnbufferedTokenStream.lastToken This is the LT(-1) token for the current position.
protected Token	UnbufferedTokenStream.lastTokenBufferStart When numMarkers > 0, this is the LT(-1) token for the first token in UnbufferedTokenStream.tokens.
Token	ParserRuleContext.start For debugging/tracing purposes, we want to track all of the nodes in the ATN traversed by the parser for a particular rule.
Token	ParserRuleContext.stop For debugging/tracing purposes, we want to track all of the nodes in the ATN traversed by the parser for a particular rule.
protected Token[]	UnbufferedTokenStream.tokens A moving window buffer of the data being scanned.

Fields in org.antlr.v4.runtime with type parameters of type Token

Modifier and Type	Field and Description
protected List<? extends Token>	ListTokenSource.tokens The wrapped collection of Token objects to return.
protected List<Token>	BufferedTokenStream.tokens A collection of all tokens fetched from the token source.

Methods in org.antlr.v4.runtime with type parameters of type Token

Modifier and Type	Method and Description
protected <T extends Token> String	DiagnosticErrorListener.getDecisionDescription(Parser recognizer, DFA dfa)
protected <Symbol extends Token> void	RecognitionException.setOffendingToken(Recognizer<Symbol,?> recognizer, Symbol offendingToken)
<T extends Token> void	BaseErrorListener.syntaxError(Recognizer<T,?> recognizer, T offendingSymbol, int line, int charPositionInLine, String msg, RecognitionException e)

Methods in org.antlr.v4.runtime that return Token

Modifier and Type	Method and Description
protected Token	DefaultErrorStrategy.constructToken(TokenSource tokenSource, int expectedTokenType, String tokenText, Token current)
Token	Parser.consume() Consume and return the current symbol.
Token	TokenFactory.create(int type, String text) Generically useful
Token	TokenFactory.create(Tuple2<? extends TokenSource,CharStream> source, int type, String text, int channel, int start, int stop, int line, int charPositionInLine) This is the method used to create tokens in the lexer and in the error handling strategy.
Token	Lexer.emit() The standard method called to automatically emit a token at the outermost lexical rule.
Token	Lexer.emitEOF()
Token	UnbufferedTokenStream.get(int i)
Token	TokenStream.get(int i) Gets the Token at the specified index in the stream.
Token	BufferedTokenStream.get(int i)
Token	Parser.getCurrentToken() Match needs to return the current input symbol, which gets put into the label for the associated token ref; e.g., x=ID.
protected Token	DefaultErrorStrategy.getMissingSymbol(Parser recognizer) Conjure up a missing token during error recovery.
Token	RecognitionException.getOffendingToken()
Token	ParserRuleContext.getStart() Get the initial token in this context.
Token	NoViableAltException.getStartToken()
Token	ParserRuleContext.getStop() Get the final token in this context.
Token	Lexer.getToken() Override if emitting multiple tokens.
protected Token	CommonTokenStream.LB(int k)
protected Token	BufferedTokenStream.LB(int k)
Token	UnbufferedTokenStream.LT(int i)
Token	TokenStream.LT(int k) Get the Token instance associated with the value returned by LA(k).
Token	CommonTokenStream.LT(int k)
Token	BufferedTokenStream.LT(int k)
Token	Parser.match(int ttype) Match current input symbol against ttype.
Token	Parser.matchWildcard() Match current input symbol as a wildcard.
Token	TokenSource.nextToken() Return a Token object from your input stream (usually a CharStream).
Token	ListTokenSource.nextToken() Return a Token object from your input stream (usually a CharStream).
Token	Lexer.nextToken() Return a token from this source; i.e., match a token on the char stream.
protected Token	ParserInterpreter.recoverInline()
Token	DefaultErrorStrategy.recoverInline(Parser recognizer) This method is called when an unexpected symbol is encountered during an inline match operation, such as Parser.match(int).
Token	BailErrorStrategy.recoverInline(Parser recognizer) Make sure we don't attempt to recover inline; if the parser successfully recovers, it won't throw an exception.
Token	ANTLRErrorStrategy.recoverInline(Parser recognizer) This method is called when an unexpected symbol is encountered during an inline match operation, such as Parser.match(int).
protected Token	DefaultErrorStrategy.singleTokenDeletion(Parser recognizer) This method implements the single-token deletion inline error recovery strategy.

Methods in org.antlr.v4.runtime that return types with arguments of type Token

Modifier and Type	Method and Description
protected List<Token>	BufferedTokenStream.filterForChannel(int from, int to, int channel)
List<Token>	BufferedTokenStream.get(int start, int stop) Get all tokens from start..stop inclusively.
List<? extends Token>	Lexer.getAllTokens() Return a list of all Token objects in input char stream.
List<Token>	BufferedTokenStream.getHiddenTokensToLeft(int tokenIndex) Collect all hidden tokens (any off-default channel) to the left of the current token up until we see a token on Lexer.DEFAULT_TOKEN_CHANNEL.
List<Token>	BufferedTokenStream.getHiddenTokensToLeft(int tokenIndex, int channel) Collect all tokens on specified channel to the left of the current token up until we see a token on Lexer.DEFAULT_TOKEN_CHANNEL.
List<Token>	BufferedTokenStream.getHiddenTokensToRight(int tokenIndex) Collect all hidden tokens (any off-default channel) to the right of the current token up until we see a token on Lexer.DEFAULT_TOKEN_CHANNEL or EOF.
List<Token>	BufferedTokenStream.getHiddenTokensToRight(int tokenIndex, int channel) Collect all tokens on specified channel to the right of the current token up until we see a token on Lexer.DEFAULT_TOKEN_CHANNEL or EOF.
List<Token>	BufferedTokenStream.getTokens()
List<Token>	BufferedTokenStream.getTokens(int start, int stop)
List<Token>	BufferedTokenStream.getTokens(int start, int stop, BitSet types) Given a start and stop index, return a List of all tokens in the token type BitSet.
List<Token>	BufferedTokenStream.getTokens(int start, int stop, int ttype)

Methods in org.antlr.v4.runtime with parameters of type Token

Modifier and Type	Method and Description
protected void	UnbufferedTokenStream.add(Token t)
TerminalNode	ParserRuleContext.addChild(Token matchedToken) Deprecated.
ErrorNode	ParserRuleContext.addErrorNode(Token badToken) Deprecated.
protected Token	DefaultErrorStrategy.constructToken(TokenSource tokenSource, int expectedTokenType, String tokenText, Token current)
ErrorNode	Parser.createErrorNode(ParserRuleContext parent, Token t) How to create an error node, given a token, associated with a parent.
TerminalNode	Parser.createTerminalNode(ParserRuleContext parent, Token t) How to create a token leaf node associated with a parent.
void	TokenStreamRewriter.delete(String programName, Token from, Token to)
void	TokenStreamRewriter.delete(Token indexT)
void	TokenStreamRewriter.delete(Token from, Token to)
void	Lexer.emit(Token token) By default does not support multiple emits per nextToken invocation for efficiency reasons.
protected String	DefaultErrorStrategy.getSymbolText(Token symbol)
protected int	DefaultErrorStrategy.getSymbolType(Token symbol)
String	Recognizer.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(org.antlr.v4.runtime.Token).
protected String	DefaultErrorStrategy.getTokenErrorDisplay(Token t) 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.
void	TokenStreamRewriter.insertAfter(String programName, Token t, Object text)
void	TokenStreamRewriter.insertAfter(Token t, Object text)
void	TokenStreamRewriter.insertBefore(String programName, Token t, Object text)
void	TokenStreamRewriter.insertBefore(Token t, Object text)
void	Parser.notifyErrorListeners(Token offendingToken, String msg, RecognitionException e)
void	TokenStreamRewriter.replace(String programName, Token from, Token to, Object text)
void	TokenStreamRewriter.replace(Token indexT, Object text)
void	TokenStreamRewriter.replace(Token from, Token to, Object text)
void	Lexer.setToken(Token _token)

Constructors in org.antlr.v4.runtime with parameters of type Token

Constructor and Description
CommonToken(Token oldToken) Constructs a new CommonToken as a copy of another Token.
NoViableAltException(Recognizer<Token,?> recognizer, TokenStream input, Token startToken, Token offendingToken, ATNConfigSet deadEndConfigs, ParserRuleContext ctx)

Constructor parameters in org.antlr.v4.runtime with type arguments of type Token

Constructor and Description
ListTokenSource(List<? extends Token> tokens) Constructs a new ListTokenSource instance from the specified collection of Token objects.
ListTokenSource(List<? extends Token> tokens, String sourceName) Constructs a new ListTokenSource instance from the specified collection of Token objects and source name.
NoViableAltException(Recognizer<Token,?> recognizer, TokenStream input, Token startToken, Token offendingToken, ATNConfigSet deadEndConfigs, ParserRuleContext ctx)
ProxyParserErrorListener(Collection<? extends ANTLRErrorListener<? super Token>> delegates)
RecognitionException(Recognizer<Token,?> recognizer, IntStream input, ParserRuleContext ctx)
RecognitionException(String message, Recognizer<Token,?> recognizer, IntStream input, ParserRuleContext ctx)

Uses of Token in org.antlr.v4.runtime.tree

Fields in org.antlr.v4.runtime.tree declared as Token

Modifier and Type	Field and Description
Token	TerminalNodeImpl.symbol

Methods in org.antlr.v4.runtime.tree that return Token

Modifier and Type	Method and Description
Token	TerminalNodeImpl.getPayload()
Token	TerminalNodeImpl.getSymbol()
Token	TerminalNode.getSymbol()

Constructors in org.antlr.v4.runtime.tree with parameters of type Token

Constructor and Description
ErrorNodeImpl(Token token)
TerminalNodeImpl(Token symbol)

Uses of Token in org.antlr.v4.runtime.tree.pattern

Classes in org.antlr.v4.runtime.tree.pattern that implement Token

Modifier and Type	Class and Description
class	RuleTagToken A Token object representing an entire subtree matched by a parser rule; e.g., <expr>.
class	TokenTagToken A Token object representing a token of a particular type; e.g., <ID>.

Methods in org.antlr.v4.runtime.tree.pattern that return types with arguments of type Token

Modifier and Type	Method and Description
List<? extends Token>	ParseTreePatternMatcher.tokenize(String pattern)

Uses of Token in org.antlr.v4.runtime.tree.xpath

Methods in org.antlr.v4.runtime.tree.xpath with parameters of type Token

Modifier and Type	Method and Description
protected XPathElement	XPath.getXPathElement(Token wordToken, boolean anywhere) Convert word like * or ID or expr to a path element.