Class RuleTagToken
java.lang.Object
org.antlr.v4.runtime.tree.pattern.RuleTagToken
- All Implemented Interfaces:
Token
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The token type for the current token.private final String
This is the backing field forgetLabel()
.private final String
This is the backing field forgetRuleName()
.Fields inherited from interface org.antlr.v4.runtime.Token
DEFAULT_CHANNEL, EOF, EPSILON, HIDDEN_CHANNEL, INVALID_TYPE, MIN_USER_CHANNEL_VALUE, MIN_USER_TOKEN_TYPE
-
Constructor Summary
ConstructorsConstructorDescriptionRuleTagToken
(String ruleName, int bypassTokenType) Constructs a new instance ofRuleTagToken
with the specified rule name and bypass token type and no label.RuleTagToken
(String ruleName, int bypassTokenType, String label) Constructs a new instance ofRuleTagToken
with the specified rule name, bypass token type, and label. -
Method Summary
Modifier and TypeMethodDescriptionint
Return the channel this token.int
The index of the first character of this token relative to the beginning of the line at which it occurs, 0..n-1Gets theCharStream
from which this token was derived.final String
getLabel()
Gets the label associated with the rule tag.int
getLine()
The line number on which the 1st character of this token was matched, line=1..nfinal String
Gets the name of the rule associated with this rule tag.int
The starting character index of the token This method is optional; return -1 if not implemented.int
The last character index of the token.getText()
Get the text of the token.int
An index from 0..n-1 of the token object in the input stream.Gets theTokenSource
which created this token.int
getType()
Get the token type of the tokentoString()
-
Field Details
-
ruleName
This is the backing field forgetRuleName()
. -
bypassTokenType
private final int bypassTokenTypeThe token type for the current token. This is the token type assigned to the bypass alternative for the rule during ATN deserialization. -
label
This is the backing field forgetLabel()
.
-
-
Constructor Details
-
RuleTagToken
Constructs a new instance ofRuleTagToken
with the specified rule name and bypass token type and no label.- Parameters:
ruleName
- The name of the parser rule this rule tag matches.bypassTokenType
- The bypass token type assigned to the parser rule.- Throws:
IllegalArgumentException
- ifruleName
isnull
or empty.
-
RuleTagToken
Constructs a new instance ofRuleTagToken
with the specified rule name, bypass token type, and label.- Parameters:
ruleName
- The name of the parser rule this rule tag matches.bypassTokenType
- The bypass token type assigned to the parser rule.label
- The label associated with the rule tag, ornull
if the rule tag is unlabeled.- Throws:
IllegalArgumentException
- ifruleName
isnull
or empty.
-
-
Method Details
-
getRuleName
Gets the name of the rule associated with this rule tag.- Returns:
- The name of the parser rule associated with this rule tag.
-
getLabel
Gets the label associated with the rule tag.- Returns:
- The name of the label associated with the rule tag, or
null
if this is an unlabeled rule tag.
-
getChannel
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.Rule tag tokens are always placed on the
Token.DEFAULT_CHANNEL
.- Specified by:
getChannel
in interfaceToken
-
getText
Get the text of the token.This method returns the rule tag formatted with
<
and>
delimiters. -
getType
public int getType()Get the token type of the tokenRule tag tokens have types assigned according to the rule bypass transitions created during ATN deserialization.
-
getLine
public int getLine()The line number on which the 1st character of this token was matched, line=1..nThe implementation for
RuleTagToken
always returns 0. -
getCharPositionInLine
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-1The implementation for
RuleTagToken
always returns -1.- Specified by:
getCharPositionInLine
in interfaceToken
-
getTokenIndex
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.The implementation for
RuleTagToken
always returns -1.- Specified by:
getTokenIndex
in interfaceToken
-
getStartIndex
public int getStartIndex()The starting character index of the token This method is optional; return -1 if not implemented.The implementation for
RuleTagToken
always returns -1.- Specified by:
getStartIndex
in interfaceToken
-
getStopIndex
public int getStopIndex()The last character index of the token. This method is optional; return -1 if not implemented.The implementation for
RuleTagToken
always returns -1.- Specified by:
getStopIndex
in interfaceToken
-
getTokenSource
Gets theTokenSource
which created this token.The implementation for
RuleTagToken
always returnsnull
.- Specified by:
getTokenSource
in interfaceToken
-
getInputStream
Gets theCharStream
from which this token was derived.The implementation for
RuleTagToken
always returnsnull
.- Specified by:
getInputStream
in interfaceToken
-
toString
The implementation for
RuleTagToken
returns a string of the formruleName:bypassTokenType
.
-