org.antlr.runtime
Class ClassicToken

java.lang.Object
  org.antlr.runtime.ClassicToken

All Implemented Interfaces:

Token

public class ClassicToken
extends Object
implements 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

protected int	channel
protected int	charPositionInLine
protected int	index What token number is this from 0..n-1 tokens
protected int	line
protected String	text
protected int	type

Fields inherited from interface org.antlr.runtime.Token

DEFAULT_CHANNEL, DOWN, EOF, EOF_TOKEN, EOR_TOKEN_TYPE, HIDDEN_CHANNEL, INVALID_TOKEN, INVALID_TOKEN_TYPE, MIN_TOKEN_TYPE, SKIP_TOKEN, UP

Constructor Summary

ClassicToken(int type)

ClassicToken(int type, String text)

ClassicToken(int type, String text, int channel)

ClassicToken(Token oldToken)

Method Summary

int	getChannel()
int	getCharPositionInLine() The index of the first character relative to the beginning of the line 0..n-1
CharStream	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..n
String	getText() Get the text of the token
int	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	setText(String text)
void	setTokenIndex(int index)
void	setType(int type)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

text

protected String text

type

protected int type

line

protected int line

charPositionInLine

protected int charPositionInLine

channel

protected int channel

index

protected int index

What token number is this from 0..n-1 tokens

Constructor Detail

ClassicToken

public ClassicToken(int type)

ClassicToken

public ClassicToken(Token oldToken)

ClassicToken

public ClassicToken(int type,
                    String text)

ClassicToken

public ClassicToken(int type,
                    String text,
                    int channel)

Method Detail

getType

public int getType()

Specified by:

getType in interface Token

setLine

public void setLine(int line)

Specified by:

setLine in interface Token

getText

public String getText()

Description copied from interface: Token

Get the text of the token

Specified by:

getText in interface Token

setText

public void setText(String text)

Specified by:

setText in interface Token

getLine

public int getLine()

Description copied from interface: Token

The line number on which this token was matched; line=1..n

Specified by:

getLine in interface Token

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 interface Token

setCharPositionInLine

public void setCharPositionInLine(int charPositionInLine)

Specified by:

setCharPositionInLine in interface Token

getChannel

public int getChannel()

Specified by:

getChannel in interface Token

setChannel

public void setChannel(int channel)

Specified by:

setChannel in interface Token

setType

public void setType(int type)

Specified by:

setType in interface Token

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 interface Token

setTokenIndex

public void setTokenIndex(int index)

Specified by:

setTokenIndex in interface Token

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 interface Token

setInputStream

public void setInputStream(CharStream input)

Specified by:

setInputStream in interface Token

toString

public String toString()

Overrides:

toString in class Object