CommonToken (ANTLR 4 Runtime 4.1 API)

java.lang.Object
- org.antlr.v4.runtime.CommonToken

All Implemented Interfaces:: Serializable, Token, WritableToken

public class CommonToken
extends Object
implements WritableToken, Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`channel`
`protected int`	`charPositionInLine`
`protected static Pair<TokenSource,CharStream>`	`EMPTY_SOURCE`
`protected int`	`index` What token number is this from 0..n-1 tokens; < 0 implies invalid index
`protected int`	`line`
`protected Pair<TokenSource,CharStream>`	`source`
`protected int`	`start` The char position into the input buffer where this token starts
`protected int`	`stop` The char position into the input buffer where this token stops
`protected String`	`text` We need to be able to change the text once in a while.
`protected int`	`type`

Fields inherited from interface org.antlr.v4.runtime.Token
DEFAULT_CHANNEL, EOF, EPSILON, HIDDEN_CHANNEL, INVALID_TYPE, MIN_USER_TOKEN_TYPE

Constructor Summary

Constructors
Constructor and Description
`CommonToken(int type)`
`CommonToken(int type, String text)`
`CommonToken(Pair<TokenSource,CharStream> source, int type, int channel, int start, int stop)`
`CommonToken(Token oldToken)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getChannel()` Return the channel this token.
`int`	`getCharPositionInLine()` The index of the first character of this token relative to the beginning of the line at which it occurs, 0..n-1
`CharStream`	`getInputStream()` Gets the `CharStream` from which this token was derived.
`int`	`getLine()` The line number on which the 1st character of this token was matched, line=1..n
`int`	`getStartIndex()` The starting character index of the token This method is optional; return -1 if not implemented.
`int`	`getStopIndex()` The last character index of the token.
`String`	`getText()` Get the text of the token
`int`	`getTokenIndex()` An index from 0..n-1 of the token object in the input stream.
`TokenSource`	`getTokenSource()` Gets the `TokenSource` which created this token.
`int`	`getType()` Get the token type of the token
`void`	`setChannel(int channel)`
`void`	`setCharPositionInLine(int charPositionInLine)`
`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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_SOURCE
```
protected static final Pair<TokenSource,CharStream> EMPTY_SOURCE
```
  - type
```
protected int type
```
  - line
```
protected int line
```
  - charPositionInLine
```
protected int charPositionInLine
```
  - channel
```
protected int channel
```
  - source
```
protected Pair<TokenSource,CharStream> source
```
  - 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(@NotNull
           Pair<TokenSource,CharStream> source,
           int type,
           int channel,
           int start,
           int stop)
```
  - CommonToken
```
public CommonToken(int type,
           String text)
```
  - CommonToken
```
public CommonToken(Token oldToken)
```
- Method Detail
  - getType
```
public int getType()
```
    Description copied from interface: Token
    
    Get the token type of the token
    
    Specified by:
    
    getType in interface Token
  - setLine
```
public void setLine(int line)
```
    Specified by:
    
    setLine in interface WritableToken
  - 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)
```
    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.
    
    Specified by:
    
    setText in interface WritableToken
  - getLine
```
public int getLine()
```
    Description copied from interface: Token
    
    The line number on which the 1st character of 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 of this token relative to the beginning of the line at which it occurs, 0..n-1
    
    Specified by:
    
    getCharPositionInLine in interface Token
  - setCharPositionInLine
```
public void setCharPositionInLine(int charPositionInLine)
```
    Specified by:
    
    setCharPositionInLine in interface WritableToken
  - getChannel
```
public int getChannel()
```
    Description copied from interface: Token
    
    Return the channel this token. Each token can arrive at the parser on a different channel, but the parser only "tunes" to a single channel. The parser ignores everything not on DEFAULT_CHANNEL.
    
    Specified by:
    
    getChannel in interface Token
  - setChannel
```
public void setChannel(int channel)
```
    Specified by:
    
    setChannel in interface WritableToken
  - setType
```
public void setType(int type)
```
    Specified by:
    
    setType in interface WritableToken
  - getStartIndex
```
public int getStartIndex()
```
    Description copied from interface: Token
    
    The starting character index of the token This method is optional; return -1 if not implemented.
    
    Specified by:
    
    getStartIndex in interface Token
  - setStartIndex
```
public void setStartIndex(int start)
```
  - getStopIndex
```
public int getStopIndex()
```
    Description copied from interface: Token
    
    The last character index of the token. This method is optional; return -1 if not implemented.
    
    Specified by:
    
    getStopIndex in interface Token
  - 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 print token streams and use TokenRewriteStream. Return -1 to indicate that this token was conjured up since it doesn't have a valid index.
    
    Specified by:
    
    getTokenIndex in interface Token
  - setTokenIndex
```
public void setTokenIndex(int index)
```
    Specified by:
    
    setTokenIndex in interface WritableToken
  - getTokenSource
```
public TokenSource getTokenSource()
```
    Description copied from interface: Token
    
    Gets the TokenSource which created this token.
    
    Specified by:
    
    getTokenSource in interface Token
  - getInputStream
```
public CharStream getInputStream()
```
    Description copied from interface: Token
    
    Gets the CharStream from which this token was derived.
    
    Specified by:
    
    getInputStream in interface Token
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CommonToken

Field Summary

Fields inherited from interface org.antlr.v4.runtime.Token

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_SOURCE

type

line

charPositionInLine

channel

source

text

index

start

stop

Constructor Detail

CommonToken

CommonToken

CommonToken

CommonToken

Method Detail

getType

setLine

getText

setText

getLine

getCharPositionInLine

setCharPositionInLine

getChannel

setChannel

setType

getStartIndex

setStartIndex

getStopIndex

setStopIndex

getTokenIndex

setTokenIndex

getTokenSource

getInputStream

toString