Package eu.bandm.tools.lexic

Interface Token<D,T>

Type Parameters:
D - the type of source document identifiers
T - the type of token types; typically (but not necessarily) an enum type
All Known Implementing Classes:
SimpleToken
public interface Token<D,T>
Abstract interface of parser tokens.

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Opt Location<D>
    getLocation()
    Returns the source location of this token.
    @Opt String
    getText()
    Returns the text content of this token.
    T
    getType()
    Returns the type of this token.
    Token<D,T>
    withType(T type)
    Returns a token that differs from this token only by a change of token type.

  • Method Details

    • getLocation

      @Opt default @Opt Location<D> getLocation()
      Returns the source location of this token.

      The default implementation returns null.

      Returns:
      the source location of this token, or null if not available.

    • getType

      T getType()
      Returns the type of this token.
      Returns:
      the type of this token.

    • getText

      @Opt @Opt String getText()
      Returns the text content of this token.

      The default implementation returns null.

      Returns:
      the text content of this token, or null if not available.

    • withType

      Token<D,T> withType(T type)
      Returns a token that differs from this token only by a change of token type.
      Parameters:
      type - the type of the new token
      Returns:
      a token that differs from this token only by having the given token type instead