Record Class VulkanMemoryHeapIndex

java.lang.Object
java.lang.Record
com.io7m.jcoronado.api.VulkanMemoryHeapIndex
Record Components:
value - The index value
All Implemented Interfaces:
Comparable<VulkanMemoryHeapIndex>
public record VulkanMemoryHeapIndex(int value) extends Record implements Comparable<VulkanMemoryHeapIndex>
The unique index of a memory heap.
See Also:

  • Constructor Details

    • VulkanMemoryHeapIndex

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

  • Method Details

    • compareTo

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

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