ANTLR 4.13.1 · org.antlr.v4.runtime.Token

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT_CHANNEL All tokens go to the parser (unless skip() is called in that rule) on a particular "channel".
public static final int	EOF
public static final int	EPSILON During lookahead operations, this "token" signifies we hit rule end ATN state and did not follow it despite needing to.
public static final int	HIDDEN_CHANNEL Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.
public static final int	INVALID_TYPE
public static final int	MIN_USER_CHANNEL_VALUE This is the minimum constant value which can be assigned to a user-defined token channel.
public static final int	MIN_USER_TOKEN_TYPE

Modifier and Type	Method and Description
public int	getChannel() Return the channel this token.
public int	getCharPositionInLine() The index of the first character of this token relative to the beginning of the line at which it occurs, 0..n-1
public CharStream	getInputStream() Gets the `CharStream` from which this token was derived.
public int	getLine() The line number on which the 1st character of this token was matched, line=1..n
public int	getStartIndex() The starting character index of the token This method is optional; return -1 if not implemented.
public int	getStopIndex() The last character index of the token.
public String	getText() Get the text of the token.
public int	getTokenIndex() An index from 0..n-1 of the token object in the input stream.
public TokenSource	getTokenSource() Gets the `TokenSource` which created this token.
public int	getType() Get the token type of the token

DEFAULT_CHANNEL	back to summary
public static final int DEFAULT_CHANNEL All tokens go to the parser (unless skip() is called in that rule) on a particular "channel". The parser tunes to a particular channel so that whitespace etc... can go to the parser on a "hidden" channel.

EOF	back to summary
public static final int EOF

EPSILON	back to summary
public static final int EPSILON During lookahead operations, this "token" signifies we hit rule end ATN state and did not follow it despite needing to.

HIDDEN_CHANNEL	back to summary
public static final int HIDDEN_CHANNEL Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.

INVALID_TYPE	back to summary
public static final int INVALID_TYPE

MIN_USER_CHANNEL_VALUE back to summary

MIN_USER_CHANNEL_VALUE	back to summary
public static final int MIN_USER_CHANNEL_VALUE This is the minimum constant value which can be assigned to a user-defined token channel. The non-negative numbers less than `MIN_USER_CHANNEL_VALUE` are assigned to the predefined channels `DEFAULT_CHANNEL` and `HIDDEN_CHANNEL`. See Also `Token#getChannel()`

public static final int MIN_USER_CHANNEL_VALUE

This is the minimum constant value which can be assigned to a user-defined token channel.

The non-negative numbers less than MIN_USER_CHANNEL_VALUE are assigned to the predefined channels DEFAULT_CHANNEL and HIDDEN_CHANNEL.

MIN_USER_TOKEN_TYPE	back to summary
public static final int MIN_USER_TOKEN_TYPE

getChannel	back to summary
public int getChannel() Return the channel this token. Each token can arrive at the parser on a different channel, but the parser only "tunes" to a single channel. The parser ignores everything not on DEFAULT_CHANNEL.

getCharPositionInLine	back to summary
public int getCharPositionInLine() The index of the first character of this token relative to the beginning of the line at which it occurs, 0..n-1

getInputStream	back to summary
public CharStream getInputStream() Gets the `CharStream` from which this token was derived.

getLine	back to summary
public int getLine() The line number on which the 1st character of this token was matched, line=1..n

getStartIndex	back to summary
public int getStartIndex() The starting character index of the token This method is optional; return -1 if not implemented.

getStopIndex	back to summary
public int getStopIndex() The last character index of the token. This method is optional; return -1 if not implemented.

getText	back to summary
public String getText() Get the text of the token.

getTokenIndex	back to summary
public int getTokenIndex() An index from 0..n-1 of the token object in the input stream. This must be valid in order to print token streams and use TokenRewriteStream. Return -1 to indicate that this token was conjured up since it doesn't have a valid index.

getTokenSource	back to summary
public TokenSource getTokenSource() Gets the `TokenSource` which created this token.

getType	back to summary
public int getType() Get the token type of the token