Record Class LifestealerUserController.ChangeHeartsResult

java.lang.Object
java.lang.Record
dev.chicoferreira.lifestealer.user.LifestealerUserController.ChangeHeartsResult
Record Components:
previousHearts - the previous amount of hearts
newHearts - the new amount of hearts
Enclosing class:
LifestealerUserController

public static record LifestealerUserController.ChangeHeartsResult(int previousHearts, int newHearts) extends Record
A result of a change for hearts of a player.
  • Constructor Summary

    Constructors
    Constructor
    Description
    ChangeHeartsResult(int previousHearts, int newHearts)
    Creates an instance of a ChangeHeartsResult record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Gets the difference between the new and previous amount of hearts (newHearts - previousHearts).
    final boolean
    Indicates whether some other object is "equal to" this one.
    boolean
    Checks if the amount of hearts has changed (previousHearts != newHearts).
    final int
    Returns a hash code value for this object.
    int
    Returns the value of the newHearts record component.
    int
    Returns the value of the previousHearts record component.
    final String
    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

    • ChangeHeartsResult

      public ChangeHeartsResult(int previousHearts, int newHearts)
      Creates an instance of a ChangeHeartsResult record class.
      Parameters:
      previousHearts - the value for the previousHearts record component
      newHearts - the value for the newHearts record component
  • Method Details

    • hasChanged

      public boolean hasChanged()
      Checks if the amount of hearts has changed (previousHearts != newHearts).
      Returns:
      if the amount of hearts has changed
    • difference

      public int difference()
      Gets the difference between the new and previous amount of hearts (newHearts - previousHearts).
      Returns:
      the difference between the new and previous amount of hearts
    • 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 '=='.
      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.
    • previousHearts

      public int previousHearts()
      Returns the value of the previousHearts record component.
      Returns:
      the value of the previousHearts record component
    • newHearts

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