org.antlr.v4.parse

Class GrammarToken

java.lang.Object

org.antlr.runtime.CommonToken

org.antlr.v4.parse.GrammarToken

All Implemented Interfaces:

java.io.Serializable, org.antlr.runtime.Token

public class GrammarToken
extends org.antlr.runtime.CommonToken

A CommonToken that can also track it's original location, derived from options on the element ref like BEGIN.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Grammar	g
int	originalTokenIndex

Fields inherited from class org.antlr.runtime.CommonToken

channel, charPositionInLine, index, input, line, start, stop, text, 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 and Description
GrammarToken(Grammar g, org.antlr.runtime.Token oldToken)

Method Summary

Methods

Modifier and Type	Method and Description
int	getCharPositionInLine() The index of the first character relative to the beginning of the line 0..n-1
int	getLine() The line number on which this token was matched; line=1..n
int	getStartIndex()
int	getStopIndex()
int	getTokenIndex() An index from 0..n-1 of the token object in the input stream.
java.lang.String	toString()

Methods inherited from class org.antlr.runtime.CommonToken

getChannel, getInputStream, getText, getType, setChannel, setCharPositionInLine, setInputStream, setLine, setStartIndex, setStopIndex, setText, setTokenIndex, setType

Methods inherited from class java.lang.Object

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

Field Detail

g

public Grammar g

originalTokenIndex

public int originalTokenIndex

Constructor Detail

GrammarToken

public GrammarToken(Grammar g,
            org.antlr.runtime.Token oldToken)

Method Detail

getCharPositionInLine

public int getCharPositionInLine()

Description copied from interface: org.antlr.runtime.Token

The index of the first character relative to the beginning of the line 0..n-1

Specified by:

getCharPositionInLine in interface org.antlr.runtime.Token

Overrides:

getCharPositionInLine in class org.antlr.runtime.CommonToken

getLine

public int getLine()

Description copied from interface: org.antlr.runtime.Token

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

Specified by:

getLine in interface org.antlr.runtime.Token

Overrides:

getLine in class org.antlr.runtime.CommonToken

getTokenIndex

public int getTokenIndex()

Description copied from interface: org.antlr.runtime.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 org.antlr.runtime.Token

Overrides:

getTokenIndex in class org.antlr.runtime.CommonToken

getStartIndex

public int getStartIndex()

Overrides:

getStartIndex in class org.antlr.runtime.CommonToken

getStopIndex

public int getStopIndex()

Overrides:

getStopIndex in class org.antlr.runtime.CommonToken

toString

public java.lang.String toString()

Overrides:

toString in class org.antlr.runtime.CommonToken