Module com.darkcollective.relix.embed
Package com.darkcollective.relix.embed

Record Class Token

java.lang.Object
java.lang.Record
com.darkcollective.relix.embed.Token
Record Components:
start - the offset of the token's first character; not negative
end - the offset just past its last character; not less than start
kind - what the token is; never null
public record Token(int start, int end, TokenKind kind) extends Record
A run of .relix text and what kind of token it is, as Relix.tokens(java.lang.String) reports it.

Offsets are 0-based char indices into the text that was tokenized: start inclusive, end exclusive, so text.substring(start, end) is the token's text.

Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Token(int start, int end, TokenKind kind)
    Checks the offsets and the kind.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    end()
    Returns the value of the end record component.
    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.
    TokenKind
    kind()
    Returns the value of the kind record component.
    int
    length()
    The token's length in chars.
    int
    start()
    Returns the value of the start record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Token

      public Token(int start, int end, TokenKind kind)
      Checks the offsets and the kind.
      Throws:
      IllegalArgumentException - if start is negative or end is less than start
      Since:
      1.0

  • Method Details

    • length

      public int length()
      The token's length in chars.
      Returns:
      end - start
      Since:
      1.0

    • 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.

    • start

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

    • end

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

    • kind

      public TokenKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component