Package za.co.wethinkcode.robots.server.persistence

Record Class WorldDimensions

java.lang.Object
java.lang.Record
za.co.wethinkcode.robots.server.persistence.WorldDimensions
Record Components:
width - the world's width
height - the world's height
visibility - the world's visibility distance
public record WorldDimensions(int width, int height, int visibility) extends Record
The geometric configuration of a saved world.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorldDimensions(int width, int height, int visibility)
    Creates an instance of a WorldDimensions 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
    height()
    Returns the value of the height record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    visibility()
    Returns the value of the visibility record component.
    int
    width()
    Returns the value of the width record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • WorldDimensions

      public WorldDimensions(int width, int height, int visibility)
      Creates an instance of a WorldDimensions record class.
      Parameters:
      width - the value for the width record component
      height - the value for the height record component
      visibility - the value for the visibility 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.

    • width

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

    • height

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

    • visibility

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