Package za.co.wethinkcode.robots.server.world

Record Class Obstacle.Brick

java.lang.Object
java.lang.Record
za.co.wethinkcode.robots.server.world.Obstacle.Brick
Record Components:
p -
All Implemented Interfaces:
WorldObject
Enclosing class:
Obstacle
public static record Obstacle.Brick(Position p) extends Record implements WorldObject
Record class of a single brick of an Obstacle

  • Constructor Summary

    Constructors
    Constructor
    Description
    Brick(Position p)
    Creates an instance of a Brick record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    blocksSightline()
    This check returns if the WorldObject in question blocks the sightline
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getSymbol()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    Position
    p()
    Returns the value of the p 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

    • Brick

      public Brick(Position p)
      Creates an instance of a Brick record class.
      Parameters:
      p - the value for the p record component

  • Method Details

    • blocksSightline

      public boolean blocksSightline()
      Description copied from interface: WorldObject
      This check returns if the WorldObject in question blocks the sightline

      Useful for the LookCommand

      Specified by:
      blocksSightline in interface WorldObject
      Returns:
      if a world object blocks the sightline, and prevents other objects from being seen beyond it

    • getSymbol

      public String getSymbol()
      Specified by:
      getSymbol in interface WorldObject

    • 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.

    • p

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