Package org.antlr.runtime
Class ClassicToken
java.lang.Object
org.antlr.runtime.ClassicToken
- All Implemented Interfaces:
Token
A Token object like we'd use in ANTLR 2.x; has an actual string created
and associated with this object. These objects are needed for imaginary
tree nodes that have payload objects. We need to create a Token object
that has a string; the tree node will point at this token. CommonToken
has indexes into a char stream and hence cannot be used to introduce
new strings.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
protected int
protected int
What token number is this from 0..n-1 tokensprotected int
protected String
protected int
Fields inherited from interface org.antlr.runtime.Token
DEFAULT_CHANNEL, DOWN, EOF, EOR_TOKEN_TYPE, HIDDEN_CHANNEL, INVALID_TOKEN, INVALID_TOKEN_TYPE, MIN_TOKEN_TYPE, SKIP_TOKEN, UP
-
Constructor Summary
ConstructorsConstructorDescriptionClassicToken
(int type) ClassicToken
(int type, String text) ClassicToken
(int type, String text, int channel) ClassicToken
(Token oldToken) -
Method Summary
Modifier and TypeMethodDescriptionint
int
The index of the first character relative to the beginning of the line 0..n-1From what character stream was this token created? You don't have to implement but it's nice to know where a Token comes from if you have include files etc...int
getLine()
The line number on which this token was matched; line=1..ngetText()
Get the text of the tokenint
An index from 0..n-1 of the token object in the input stream.int
getType()
void
setChannel
(int channel) void
setCharPositionInLine
(int charPositionInLine) void
setInputStream
(CharStream input) void
setLine
(int line) void
void
setTokenIndex
(int index) void
setType
(int type) toString()
-
Field Details
-
text
-
type
protected int type -
line
protected int line -
charPositionInLine
protected int charPositionInLine -
channel
protected int channel -
index
protected int indexWhat token number is this from 0..n-1 tokens
-
-
Constructor Details
-
ClassicToken
public ClassicToken(int type) -
ClassicToken
-
ClassicToken
-
ClassicToken
-
-
Method Details
-
getType
public int getType() -
setLine
public void setLine(int line) -
getText
Description copied from interface:Token
Get the text of the token -
setText
-
getLine
public int getLine()Description copied from interface:Token
The line number on which this token was matched; line=1..n -
getCharPositionInLine
public int getCharPositionInLine()Description copied from interface:Token
The index of the first character relative to the beginning of the line 0..n-1- Specified by:
getCharPositionInLine
in interfaceToken
-
setCharPositionInLine
public void setCharPositionInLine(int charPositionInLine) - Specified by:
setCharPositionInLine
in interfaceToken
-
getChannel
public int getChannel()- Specified by:
getChannel
in interfaceToken
-
setChannel
public void setChannel(int channel) - Specified by:
setChannel
in interfaceToken
-
setType
public void setType(int type) -
getTokenIndex
public int getTokenIndex()Description copied from interface:Token
An index from 0..n-1 of the token object in the input stream. This must be valid in order to use the ANTLRWorks debugger.- Specified by:
getTokenIndex
in interfaceToken
-
setTokenIndex
public void setTokenIndex(int index) - Specified by:
setTokenIndex
in interfaceToken
-
getInputStream
Description copied from interface:Token
From what character stream was this token created? You don't have to implement but it's nice to know where a Token comes from if you have include files etc... on the input.- Specified by:
getInputStream
in interfaceToken
-
setInputStream
- Specified by:
setInputStream
in interfaceToken
-
toString
-