Package org.antlr.runtime

Interface Token

All Known Implementing Classes:
ClassicToken, CommonToken, RemoteDebugEventSocketListener.ProxyToken
public interface Token

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_CHANNEL
    All tokens go to the parser (unless skip() is called in that rule) on a particular "channel".
    static final int
    DOWN
    imaginary tree navigation type; traverse "get child" link
    static final int
    EOF
     
    static final Token
    EOF_TOKEN
     
    static final int
    EOR_TOKEN_TYPE
     
    static final int
    HIDDEN_CHANNEL
    Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.
    static final Token
    INVALID_TOKEN
     
    static final int
    INVALID_TOKEN_TYPE
     
    static final int
    MIN_TOKEN_TYPE
     
    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.
    static final int
    UP
    imaginary tree navigation type; finish with a child list

  • Method Summary

    Modifier and Type
    Method
    Description
    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 pos)
     
    void
    setInputStream(CharStream input)
     
    void
    setLine(int line)
     
    void
    setText(String text)
     
    void
    setTokenIndex(int index)
     
    void
    setType(int ttype)
     

  • Field Details

    • EOR_TOKEN_TYPE

      static final int EOR_TOKEN_TYPE
      See Also:

    • DOWN

      static final int DOWN
      imaginary tree navigation type; traverse "get child" link
      See Also:

    • UP

      static final int UP
      imaginary tree navigation type; finish with a child list
      See Also:

    • MIN_TOKEN_TYPE

      static final int MIN_TOKEN_TYPE
      See Also:

    • EOF

      static final int EOF
      See Also:

    • EOF_TOKEN

      static final Token EOF_TOKEN

    • INVALID_TOKEN_TYPE

      static final int INVALID_TOKEN_TYPE
      See Also:

    • INVALID_TOKEN

      static final Token INVALID_TOKEN

    • SKIP_TOKEN

      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.

    • DEFAULT_CHANNEL

      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.
      See Also:

    • HIDDEN_CHANNEL

      static final int HIDDEN_CHANNEL
      Anything on different channel than DEFAULT_CHANNEL is not parsed by parser.
      See Also:

  • Method Details

    • getText

      String getText()
      Get the text of the token

    • setText

      void setText(String text)

    • getType

      int getType()

    • setType

      void setType(int ttype)

    • getLine

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

    • setLine

      void setLine(int line)

    • getCharPositionInLine

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

    • setCharPositionInLine

      void setCharPositionInLine(int pos)

    • getChannel

      int getChannel()

    • setChannel

      void setChannel(int channel)

    • getTokenIndex

      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.

    • setTokenIndex

      void setTokenIndex(int index)

    • getInputStream

      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.

    • setInputStream

      void setInputStream(CharStream input)