Module com.maroontress.clione
Package com.maroontress.clione

Interface Token

All Known Implementing Classes:
DefaultToken
public interface Token
The preprocessing token.

Token objects can have children, which means they can be in a tree structure. For tokens that the LexicalParser.next() method returns, tokens of type TokenType.DIRECTIVE only have children.

The Token object has its type, span, and characters. The type is one of the constants defined in TokenType, the span represents the range of the source file where the token occurs, and the characters are SourceChar objects that compose it.

Note that the Token object is an immutable object.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<SourceChar>
    getChars()
    Returns the characters that compose this token.
    List<Token>
    getChildren()
    Returns the child tokens.
    SourceSpan
    getSpan()
    Returns a new span representing the range of this token in the source file.
    TokenType
    getType()
    Returns the type of this token.
    String
    getValue()
    Returns a new string representing this token.
    default boolean
    isType(TokenType type)
    Tests whether this token has the specified token type.
    default boolean
    isValue(String value)
    Tests if the characters of this token form the given string.
    String
    toString()
    Returns a new string representation of this token that is easy for a person to read.
    Token
    withChildren(Collection<Token> newChildren)
    Returns a new token that has the same content of this token but has the specified child tokens.
    Token
    withType(TokenType newType)
    Returns a new token that has the same content of this token but has the specified token type.

  • Method Details

    • getValue

      String getValue()
      Returns a new string representing this token.

      The string that this method returns does not have the clue of the token type and does not include the content of the child tokens.

      Returns:
      The new string representing this token.

    • getSpan

      SourceSpan getSpan()
      Returns a new span representing the range of this token in the source file.
      Returns:
      A new span representing the range of this token.

    • getChars

      List<SourceChar> getChars()
      Returns the characters that compose this token.
      Returns:
      The unmodifiable list containing the characters that compose this token.

    • getType

      TokenType getType()
      Returns the type of this token.
      Returns:
      The type of this token.

    • getChildren

      List<Token> getChildren()
      Returns the child tokens.

      This method returns an empty list if this token has no child tokens.

      Returns:
      The unmodifiable list containing the child tokens.

    • withType

      Token withType(TokenType newType)
      Returns a new token that has the same content of this token but has the specified token type.
      Parameters:
      newType - The token type of the new token.
      Returns:
      The new token.

    • withChildren

      Token withChildren(Collection<Token> newChildren)
      Returns a new token that has the same content of this token but has the specified child tokens.
      Parameters:
      newChildren - The child tokens of the new token.
      Returns:
      The new token.

    • toString

      String toString()
      Returns a new string representation of this token that is easy for a person to read.

      This method returns a string equal to the value of:

              "[value=" + getValue() + ", span=" + getSpan() + ", "
            + "chars=" + getChars() + ", type=" + getType() + ", "
            + "children=" + getChildren() + "]";
      Overrides:
      toString in class Object
      Returns:
      The new string representation of this token.

    • isValue

      default boolean isValue(String value)
      Tests if the characters of this token form the given string.

      Returns true if and only if the given string and the return value of getValue() are equal.

      The comparison is exact (case-sensitive), does not perform any normalization or trimming, and considers only this token's characters (child tokens, if any, are not involved).

      Parameters:
      value - the string to compare with the token's characters; must not be null.
      Returns:
      true if the token's characters equal the given string; false otherwise.

    • isType

      default boolean isType(TokenType type)
      Tests whether this token has the specified token type.

      Returns true if and only if the specified type is the same enum constant as returned by getType().

      Parameters:
      type - the token type to compare; may be null
      Returns:
      true if this token's type equals type; false otherwise