Module com.darkcollective.relix.parser
Package com.darkcollective.relix.parser

Record Class Token

java.lang.Object
java.lang.Record
com.darkcollective.relix.parser.Token
Record Components:
type - the syntactic category of this token
lexeme - the raw characters from the source input
literal - the processed value (e.g. decoded string body); may be null for tokens that carry no additional value
line - 1-based line number within the source text
column - 1-based column number within the line
public record Token(TokenType type, String lexeme, String literal, int line, int column) extends Record
An immutable token produced by the Lexer.

Each token records its syntactic category (type), the raw source text it was scanned from (lexeme), an optional processed literal value (literal — used for string tokens with escape sequences decoded), and the 1-based source position where it begins.

  • Constructor Details

    • Token

      public Token(TokenType type, String lexeme, String literal, int line, int column)
      Creates an instance of a Token record class.
      Parameters:
      type - the value for the type record component
      lexeme - the value for the lexeme record component
      literal - the value for the literal record component
      line - the value for the line record component
      column - the value for the column record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • type

      public TokenType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • lexeme

      public String lexeme()
      Returns the value of the lexeme record component.
      Returns:
      the value of the lexeme record component

    • literal

      public String literal()
      Returns the value of the literal record component.
      Returns:
      the value of the literal record component

    • line

      public int line()
      Returns the value of the line record component.
      Returns:
      the value of the line record component

    • column

      public int column()
      Returns the value of the column record component.
      Returns:
      the value of the column record component