Package battleship.model.game

Record Class HealthReport

java.lang.Object
java.lang.Record
battleship.model.game.HealthReport
public record HealthReport(int healthRemaining, int scoreByHit) extends Record
Health report (contains ship health remaining, and power of attack).

  • Constructor Summary

    Constructors
    Constructor
    Description
    HealthReport(int healthRemaining, int scoreByHit)
    Creates an instance of a HealthReport 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
    healthRemaining()
    Returns the value of the healthRemaining record component.
    int
    scoreByHit()
    Returns the value of the scoreByHit 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

    • HealthReport

      public HealthReport(int healthRemaining, int scoreByHit)
      Creates an instance of a HealthReport record class.
      Parameters:
      healthRemaining - the value for the healthRemaining record component
      scoreByHit - the value for the scoreByHit 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 '=='.
      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.

    • healthRemaining

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

    • scoreByHit

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