Package io.github.srcimon.screwbox.core

Record Class Grid.Node

java.lang.Object
java.lang.Record
io.github.srcimon.screwbox.core.Grid.Node
Enclosing class:
Grid
public static record Grid.Node(int x, int y, Grid.Node parent) extends Record
A node in (or out of) the Grid. Can have parent() Grid.Nodes when created relatively to other Grid.Nodes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Node(int x, int y, Grid.Node parent)
    Creates an instance of a Node record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    distance(Grid.Node other)
    Returns the distance between this Grid.Node and another Grid.Node.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    Grid.Node
    parent()
    Returns the value of the parent record component.
    String
    toString()
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Node

      public Node(int x, int y, Grid.Node parent)
      Creates an instance of a Node record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      parent - the value for the parent record component

  • Method Details

    • hashCode

      public 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 boolean equals(Object obj)
      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 '=='.
      Specified by:
      equals in class Record
      Parameters:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj argument; false otherwise.

    • toString

      public 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

    • distance

      public double distance(Grid.Node other)
      Returns the distance between this Grid.Node and another Grid.Node. Distance doesn't consider Grid.gridSize.

    • x

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

    • y

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

    • parent

      public Grid.Node parent()
      Returns the value of the parent record component.
      Returns:
      the value of the parent record component