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

Record Class ErrorToken

java.lang.Object
java.lang.Record
org.kink_lang.kink.internal.program.lex.ErrorToken
Record Components:
msg - the error msg.
startPos - the start pos.
endPos - the end pos.
All Implemented Interfaces:
Token
public record ErrorToken(String msg, int startPos, int endPos) extends Record implements Token
A special token which indicates an error in lexical analysis.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ErrorToken(String msg, int startPos, int endPos)
    Creates an instance of a ErrorToken record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    endPos()
    Returns the value of the endPos 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.
    String
    msg()
    Returns the value of the msg record component.
    int
    startPos()
    Returns the value of the startPos 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

    • ErrorToken

      public ErrorToken(String msg, int startPos, int endPos)
      Creates an instance of a ErrorToken record class.
      Parameters:
      msg - the value for the msg record component
      startPos - the value for the startPos record component
      endPos - the value for the endPos 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.

    • msg

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

    • startPos

      public int startPos()
      Returns the value of the startPos record component.
      Specified by:
      startPos in interface Token
      Returns:
      the value of the startPos record component

    • endPos

      public int endPos()
      Returns the value of the endPos record component.
      Specified by:
      endPos in interface Token
      Returns:
      the value of the endPos record component