Record Class IGame.ShotResult

java.lang.Object
java.lang.Record
battleship.IGame.ShotResult
Enclosing interface:
IGame
public static record IGame.ShotResult(boolean valid, boolean repeated, IShip ship, boolean sunk) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShotResult(boolean valid, boolean repeated, IShip ship, boolean sunk)
    Creates an instance of a ShotResult 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.
    boolean
    repeated()
    Returns the value of the repeated record component.
    IShip
    ship()
    Returns the value of the ship record component.
    boolean
    sunk()
    Returns the value of the sunk record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    valid()
    Returns the value of the valid record component.

    Methods inherited from class Object

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

  • Constructor Details

    • ShotResult

      public ShotResult(boolean valid, boolean repeated, IShip ship, boolean sunk)
      Creates an instance of a ShotResult record class.
      Parameters:
      valid - the value for the valid record component
      repeated - the value for the repeated record component
      ship - the value for the ship record component
      sunk - the value for the sunk 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • valid

      public boolean valid()
      Returns the value of the valid record component.
      Returns:
      the value of the valid record component

    • repeated

      public boolean repeated()
      Returns the value of the repeated record component.
      Returns:
      the value of the repeated record component

    • ship

      public IShip ship()
      Returns the value of the ship record component.
      Returns:
      the value of the ship record component

    • sunk

      public boolean sunk()
      Returns the value of the sunk record component.
      Returns:
      the value of the sunk record component