Module org.kink_lang.kink
Package org.kink_lang.kink.internal.callstack

Record Class Location

java.lang.Object
java.lang.Record
org.kink_lang.kink.internal.callstack.Location
Record Components:
programName - the name of the program.
programText - the program text.
pos - the pos on the program; adjusted to the range of the program text.
public record Location(String programName, String programText, int pos) extends Record
A position on a program; used in stack traces.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Location
    EMPTY
    Location with empty programName, empty programText and pos=0.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Location(String programName, String programText, int pos)
    Constructs a location.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    pos()
    Returns the value of the pos record component.
    String
    programName()
    Returns the value of the programName record component.
    String
    programText()
    Returns the value of the programText 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

  • Field Details

    • EMPTY

      public static final Location EMPTY
      Location with empty programName, empty programText and pos=0.

  • Constructor Details

    • Location

      public Location(String programName, String programText, int pos)
      Constructs a location.
      Parameters:
      programName - the name of the program.
      programText - the program text.
      pos - the pos on the program; adjusted to the range of the program text.

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

    • programName

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

    • programText

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

    • pos

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