Package org.antlr.runtime
Class CommonToken
- java.lang.Object
-
- org.antlr.runtime.CommonToken
-
- All Implemented Interfaces:
Serializable
,Token
public class CommonToken extends Object implements Token, Serializable
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected int
channel
protected int
charPositionInLine
protected int
index
What token number is this from 0..n-1 tokens; < 0 implies invalid indexprotected CharStream
input
protected int
line
protected int
start
The char position into the input buffer where this token startsprotected int
stop
The char position into the input buffer where this token stopsprotected String
text
We need to be able to change the text once in a while.protected int
type
-
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
Constructors Constructor Description CommonToken(int type)
CommonToken(int type, String text)
CommonToken(CharStream input, int type, int channel, int start, int stop)
CommonToken(Token oldToken)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getChannel()
int
getCharPositionInLine()
The index of the first character relative to the beginning of the line 0..n-1CharStream
getInputStream()
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...int
getLine()
The line number on which this token was matched; line=1..nint
getStartIndex()
int
getStopIndex()
String
getText()
Get the text of the tokenint
getTokenIndex()
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
setStartIndex(int start)
void
setStopIndex(int stop)
void
setText(String text)
Override the text for this token.void
setTokenIndex(int index)
void
setType(int type)
String
toString()
-
-
-
Field Detail
-
type
protected int type
-
line
protected int line
-
charPositionInLine
protected int charPositionInLine
-
channel
protected int channel
-
input
protected transient CharStream input
-
text
protected String text
We need to be able to change the text once in a while. If this is non-null, then getText should return this. Note that start/stop are not affected by changing this.
-
index
protected int index
What token number is this from 0..n-1 tokens; < 0 implies invalid index
-
start
protected int start
The char position into the input buffer where this token starts
-
stop
protected int stop
The char position into the input buffer where this token stops
-
-
Constructor Detail
-
CommonToken
public CommonToken(int type)
-
CommonToken
public CommonToken(CharStream input, int type, int channel, int start, int stop)
-
CommonToken
public CommonToken(int type, String text)
-
CommonToken
public CommonToken(Token oldToken)
-
-
Method Detail
-
setText
public void setText(String text)
Override the text for this token. getText() will return this text rather than pulling from the buffer. Note that this does not mean that start/stop indexes are not valid. It means that that input was converted to a new string in the token object.
-
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
-
getStartIndex
public int getStartIndex()
-
setStartIndex
public void setStartIndex(int start)
-
getStopIndex
public int getStopIndex()
-
setStopIndex
public void setStopIndex(int stop)
-
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
public CharStream 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
public void setInputStream(CharStream input)
- Specified by:
setInputStream
in interfaceToken
-
-