Module com.darkcollective.relix.lang
Package com.darkcollective.relix.lang

Record Class LangToken

java.lang.Object
java.lang.Record
com.darkcollective.relix.lang.LangToken
Record Components:
type - the token category
value - the raw lexeme text as it appeared in the source (for LangTokenType.STRING_LIT this is the content without the surrounding quotes, with escape sequences resolved)
line - 1-based source line number of the first character
column - 1-based source column number of the first character
public record LangToken(LangTokenType type, String value, int line, int column) extends Record
A single token produced by the LangLexer.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LangToken(LangTokenType type, String value, int line, int column)
    Creates an instance of a LangToken record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    column()
    Returns the value of the column record component.
    String
    describe()
    Returns a human-readable description of this token suitable for use in error messages (e.g.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    line()
    Returns the value of the line record component.
    final String
    toString()
    Returns a string representation of this record class.
    LangTokenType
    type()
    Returns the value of the type record component.
    String
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LangToken

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

  • Method Details

    • describe

      public String describe()
      Returns a human-readable description of this token suitable for use in error messages (e.g. "'import' at line 3, col 1").

    • 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 LangTokenType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • value

      public String value()
      Returns the value of the value record component.
      Returns:
      the value of the value 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