Module org.kink_lang.kink
Package org.kink_lang.kink.internal.program.lex

Record Class EotToken

java.lang.Object
java.lang.Record
org.kink_lang.kink.internal.program.lex.EotToken
Record Components:
textLength - the length of the program text.
All Implemented Interfaces:
Token
public record EotToken(int textLength) extends Record implements Token
A special token which indicates the end-of-text.

The token is always on the end of the program text, and is zero-width. Thus getTextLength, getStartPos, and getEndPos always the return equal value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EotToken(int textLength)
    Creates an instance of a EotToken record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    endPos()
    Returns the position index on which the token ends.
    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
    startPos()
    Returns the position index on which the token starts.
    int
    textLength()
    Returns the value of the textLength 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

    • EotToken

      public EotToken(int textLength)
      Creates an instance of a EotToken record class.
      Parameters:
      textLength - the value for the textLength record component

  • Method Details

    • startPos

      public int startPos()
      Description copied from interface: Token
      Returns the position index on which the token starts.
      Specified by:
      startPos in interface Token
      Returns:
      the position index on which the token starts.

    • endPos

      public int endPos()
      Description copied from interface: Token
      Returns the position index on which the token ends.
      Specified by:
      endPos in interface Token
      Returns:
      the position index on which the token starts.

    • 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. All components in this record class 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.

    • textLength

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