Record Class MazeLayout.Portal

java.lang.Object
java.lang.Record
dev.despical.mazeengine.core.MazeLayout.Portal
Enclosing class:
MazeLayout
public static record MazeLayout.Portal(int cell, Direction side) extends Record
Identifies a boundary cell and the side opening to the outside.

The cell index belongs to the layout's logical grid. The side defines the external opening used by the block plan and arrival geometry; it is not an additional internal edge when routing or counting dead ends.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Portal(int cell, Direction side)
    Creates an instance of a Portal record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    cell()
    Returns the value of the cell record component.
    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.
    Direction
    side()
    Returns the value of the side record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Portal

      public Portal(int cell, Direction side)
      Creates an instance of a Portal record class.
      Parameters:
      cell - the value for the cell record component
      side - the value for the side 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.

    • cell

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

    • side

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