Record Class ClientStats.Usage

java.lang.Object
java.lang.Record
org.mqtt4j.hato.ClientStats.Usage
Record Components:
used - how much is in use
limit - the most that may be in use
Enclosing class:
ClientStats
public static record ClientStats.Usage(long used, long limit) extends Record
How much of a limit is in use.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Usage(long used, long limit)
    Creates an instance of a Usage 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.
    long
    limit()
    Returns the value of the limit record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    used()
    Returns the value of the used record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Usage

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

    • used

      public long used()
      Returns the value of the used record component.
      Returns:
      the value of the used record component

    • limit

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