Record Class SyWindowLayerID

java.lang.Object
java.lang.Record
com.io7m.jsycamore.api.windows.SyWindowLayerID
Record Components:
value - The value
All Implemented Interfaces:
Comparable<SyWindowLayerID>
public record SyWindowLayerID(BigInteger value) extends Record implements Comparable<SyWindowLayerID>
An identifier for a window layer.

  • Constructor Details

    • SyWindowLayerID

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

  • Method Details

    • compareTo

      public int compareTo(SyWindowLayerID other)
      Specified by:
      compareTo in interface Comparable<SyWindowLayerID>

    • nextHigher

      public SyWindowLayerID nextHigher()
      Returns:
      The next layer ID

    • nextLower

      public SyWindowLayerID nextLower()
      Returns:
      The next layer ID

    • defaultLayer

      public static SyWindowLayerID defaultLayer()
      Returns:
      The default layer ID

    • 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 Objects::equals(Object,Object).
      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 BigInteger value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component