Record Class LimitInfo

java.lang.Object
java.lang.Record
org.mineskin.data.LimitInfo
public record LimitInfo(int limit, int remaining) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    LimitInfo(int limit, int remaining)
    Creates an instance of a LimitInfo record class.

  • 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
    limit()
    Returns the value of the limit record component.
    int
    remaining()
    Returns the value of the remaining 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

    • LimitInfo

      public LimitInfo(int limit, int remaining)
      Creates an instance of a LimitInfo record class.
      Parameters:
      limit - the value for the limit record component
      remaining - the value for the remaining 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. 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.

    • limit

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

    • remaining

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