Package za.co.wethinkcode.robots.server.serverRobot

Record Class RobotState

java.lang.Object
java.lang.Record
za.co.wethinkcode.robots.server.serverRobot.RobotState
Record Components:
position - where the robot is
direction - what direction the robot is facing
shields - how many shields the robot has
shots - how many shots the robot has left
status - what status the robot is in
public record RobotState(Position position, Direction direction, Integer shields, Integer shots, RobotStatus status) extends Record
Record class for capturing a Robot's state

  • Constructor Details

    • RobotState

      public RobotState(Position position, Direction direction, Integer shields, Integer shots, RobotStatus status)
      Creates an instance of a RobotState record class.
      Parameters:
      position - the value for the position record component
      direction - the value for the direction record component
      shields - the value for the shields record component
      shots - the value for the shots record component
      status - the value for the status 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 Objects::equals(Object,Object).
      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.

    • position

      public Position position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • direction

      public Direction direction()
      Returns the value of the direction record component.
      Returns:
      the value of the direction record component

    • shields

      public Integer shields()
      Returns the value of the shields record component.
      Returns:
      the value of the shields record component

    • shots

      public Integer shots()
      Returns the value of the shots record component.
      Returns:
      the value of the shots record component

    • status

      public RobotStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component