Top Fields Methods

org.antlr.runtime

public Interface Token

Known Direct Implementers: org.antlr.runtime.debug.RemoteDebugEventSocketListener.ProxyToken, org.antlr.runtime.ClassicToken, org.antlr.runtime.CommonToken

Field Summary

Modifier and Type	Field and Description
public static final int	DEFAULT_CHANNEL All tokens go to the parser (unless skip() is called in that rule) on a particular "channel".
public static final int	DOWN imaginary tree navigation type; traverse "get child" link
public static final int	EOF
public static final int	EOR_TOKEN_TYPE
public static final int	HIDDEN_CHANNEL Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.
public static final Token	INVALID_TOKEN
public static final int	INVALID_TOKEN_TYPE
public static final int	MIN_TOKEN_TYPE
public static final Token	SKIP_TOKEN In an action, a lexer rule can set token to this SKIP_TOKEN and ANTLR will avoid creating a token for this symbol and try to fetch another.
public static final int	UP imaginary tree navigation type; finish with a child list

Method Summary

Modifier and Type	Method and Description
public int	getChannel()
public int	getCharPositionInLine() The index of the first character relative to the beginning of the line 0..n-1
public CharStream	getInputStream() From what character stream was this token created?
public int	getLine() The line number on which this token was matched; line=1..n
public String	getText() Get the text of the token
public int	getTokenIndex() An index from 0..n-1 of the token object in the input stream.
public int	getType()
public void	setChannel(int channel)
public void	setCharPositionInLine(int pos)
public void	setInputStream(CharStream input)
public void	setLine(int line)
public void	setText(String text)
public void	setTokenIndex(int index)
public void	setType(int ttype)

Field Detail

DEFAULT_CHANNEL	back to summary
public static final int DEFAULT_CHANNEL 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.

DOWN	back to summary
public static final int DOWN imaginary tree navigation type; traverse "get child" link

EOF	back to summary
public static final int EOF

EOR_TOKEN_TYPE	back to summary
public static final int EOR_TOKEN_TYPE

HIDDEN_CHANNEL	back to summary
public static final int HIDDEN_CHANNEL Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.

INVALID_TOKEN	back to summary
public static final Token INVALID_TOKEN

INVALID_TOKEN_TYPE	back to summary
public static final int INVALID_TOKEN_TYPE

MIN_TOKEN_TYPE	back to summary
public static final int MIN_TOKEN_TYPE

SKIP_TOKEN	back to summary
public static final Token SKIP_TOKEN In an action, a lexer rule can set token to this SKIP_TOKEN and ANTLR will avoid creating a token for this symbol and try to fetch another.

UP	back to summary
public static final int UP imaginary tree navigation type; finish with a child list

Method Detail

getChannel	back to summary
public int getChannel()

getCharPositionInLine	back to summary
public int getCharPositionInLine() The index of the first character relative to the beginning of the line 0..n-1

getInputStream	back to summary
public 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... on the input.

getLine	back to summary
public int getLine() The line number on which this token was matched; line=1..n

getText	back to summary
public String getText() Get the text of the token

getTokenIndex	back to summary
public int getTokenIndex() 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.

getType	back to summary
public int getType()

setChannel	back to summary
public void setChannel(int channel)

setCharPositionInLine	back to summary
public void setCharPositionInLine(int pos)

setInputStream	back to summary
public void setInputStream(CharStream input)

setLine	back to summary
public void setLine(int line)

setText	back to summary
public void setText(String text)

setTokenIndex	back to summary
public void setTokenIndex(int index)

setType	back to summary
public void setType(int ttype)