Record Class CellPosition

java.lang.Object
java.lang.Record
dev.despical.mazeengine.api.model.CellPosition
Record Components:
x - the nonnegative column index
z - the nonnegative row index
public record CellPosition(int x, int z) extends Record
Identifies one cell in a maze's logical graph.

The X coordinate is the zero-based column and Z is the zero-based row. These indices are independent of world block coordinates, corridor width, wall thickness, and the maze's world origin.

Construction rejects negative indices. A position is not tied to one maze; MazeRegistry.route(MazeId, CellPosition, CellPosition) checks its upper bounds against the selected maze when a route is requested.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CellPosition(int x, int z)
    Constructs a cell position with nonnegative indices.

  • 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.
    final String
    toString()
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

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

  • Constructor Details

    • CellPosition

      public CellPosition(int x, int z)
      Constructs a cell position with nonnegative indices.

      No maze-specific upper bound is checked here. The same position can be used with any maze whose grid contains the selected column and row.

      Parameters:
      x - the zero-based column index
      z - the zero-based row index
      Throws:
      IllegalArgumentException - if either index is negative

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

    • x

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

    • z

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