Record Class SyTextLineNumber

java.lang.Object
java.lang.Record
com.io7m.jsycamore.api.text.SyTextLineNumber
Record Components:
value - The line number
All Implemented Interfaces:
Comparable<SyTextLineNumber>
public record SyTextLineNumber(int value) extends Record implements Comparable<SyTextLineNumber>
A line number.

  • Constructor Details

    • SyTextLineNumber

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

  • Method Details

    • first

      public static SyTextLineNumber first()
      Returns:
      The first line number

    • toString

      public 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

    • compareTo

      public int compareTo(SyTextLineNumber o)
      Specified by:
      compareTo in interface Comparable<SyTextLineNumber>

    • next

      public SyTextLineNumber next()
      Returns:
      The next line number

    • adjust

      public SyTextLineNumber adjust(int delta)
      Parameters:
      delta - The delta
      Returns:
      The line number adjusted by the given delta

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • value

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