Token class abstract

A token has properties: text, type, line, character position in the line (so we can ignore tabs), token channel, index, and source from which we obtained this token.

Implementers

Constructors

Token()

Properties

channel int
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.
no setter
charPositionInLine int
The index of the first character of this token relative to the beginning of the line at which it occurs, 0..n-1
no setter
hashCode int
The hash code for this object.
no setterinherited
inputStream CharStream?
Gets the CharStream from which this token was derived.
no setter
line int?
The line number on which the 1st character of this token was matched, line=1..n
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
startIndex int
The starting character index of the token This method is optional; return -1 if not implemented.
no setter
stopIndex int
The last character index of the token. This method is optional; return -1 if not implemented.
no setter
text String?
Get the text of the token.
no setter
tokenIndex int
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.
no setter
tokenSource TokenSource?
Gets the TokenSource which created this token.
no setter
type int
Get the token type of the token
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

DEFAULT_CHANNEL → const int
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 → const int
EPSILON → const int
During lookahead operations, this "token" signifies we hit rule end ATN state and did not follow it despite needing to.
HIDDEN_CHANNEL → const int
Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.
INVALID_TYPE → const int
MIN_USER_CHANNEL_VALUE → const int
This is the minimum constant value which can be assigned to a user-defined token channel.
MIN_USER_TOKEN_TYPE → const int