Record Class PathResult

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.PathResult
Record Components:
found - whether a path was found
pathLength - number of tiles in the path
path - ordered list of world-coordinate tiles from start to destination
public record PathResult(boolean found, int pathLength, List<int[]> path) extends Record
Result of a pathfinding query.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PathResult(boolean found, int pathLength, List<int[]> path)
    Creates an instance of a PathResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    found()
    Returns the value of the found record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    List<int[]>
    path()
    Returns the value of the path record component.
    int
    pathLength()
    Returns the value of the pathLength record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PathResult

      public PathResult(boolean found, int pathLength, List<int[]> path)
      Creates an instance of a PathResult record class.
      Parameters:
      found - the value for the found record component
      pathLength - the value for the pathLength record component
      path - the value for the path 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.

    • found

      public boolean found()
      Returns the value of the found record component.
      Returns:
      the value of the found record component

    • pathLength

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

    • path

      public List<int[]> path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component