Package gg.xp.xivsupport.models

Record Class HitPoints

java.lang.Object
java.lang.Record
gg.xp.xivsupport.models.HitPoints
All Implemented Interfaces:
CurrentMaxPair, Serializable
public record HitPoints(long current, long max) extends Record implements CurrentMaxPair, Serializable
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    HitPoints(long current, long max)
    Creates an instance of a HitPoints record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    current()
    Returns the value of the current record component.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    long
    max()
    Returns the value of the max record component.
    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

    Methods inherited from interface gg.xp.xivsupport.models.CurrentMaxPair

    getPercent, getShortString, isEmpty, isFull

  • Constructor Details

    • HitPoints

      public HitPoints(long current, long max)
      Creates an instance of a HitPoints record class.
      Parameters:
      current - the value for the current record component
      max - the value for the max record component

  • Method Details

    • current

      public long current()
      Returns the value of the current record component.
      Specified by:
      current in interface CurrentMaxPair
      Returns:
      the value of the current record component

    • max

      public long max()
      Returns the value of the max record component.
      Specified by:
      max in interface CurrentMaxPair
      Returns:
      the value of the max record component

    • 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

    • equals

      public 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 '=='.
      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.

    • hashCode

      public 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