Record Class PointRange3D

java.lang.Object
java.lang.Record
dev.wyck.misc.PointRange3D
@NullMarked @AsOf("0.0.1") public record PointRange3D(int minX, int maxX, int minY, int maxY, int minZ, int maxZ) extends Record
Represents a 3D range of points defined by minimum and maximum coordinates in each axis (X, Y, Z). This class is a record, which is an immutable data carrier.
Since:
0.0.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    PointRange3D(int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
    Creates an instance of a PointRange3D record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Location
    getMaxLocation(World world)
    Returns the maximum location within the range.
    Location
    getMinLocation(World world)
    Returns the minimum location within the range.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxX()
    Returns the value of the maxX record component.
    int
    maxY()
    Returns the value of the maxY record component.
    int
    maxZ()
    Returns the value of the maxZ record component.
    int
    minX()
    Returns the value of the minX record component.
    int
    minY()
    Returns the value of the minY record component.
    int
    minZ()
    Returns the value of the minZ record component.
    static PointRange3D
    of(Location from, Location to)
    Creates a new PointRange3D object based on two given locations.
    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

    • PointRange3D

      public PointRange3D(int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
      Creates an instance of a PointRange3D record class.
      Parameters:
      minX - the value for the minX record component
      maxX - the value for the maxX record component
      minY - the value for the minY record component
      maxY - the value for the maxY record component
      minZ - the value for the minZ record component
      maxZ - the value for the maxZ record component

  • Method Details

    • of

      @AsOf("0.0.1") public static PointRange3D of(Location from, Location to)
      Creates a new PointRange3D object based on two given locations. The minimum and maximum coordinates are calculated for each axis based on the provided locations.
      Parameters:
      from - The first location.
      to - The second location.
      Returns:
      A new PointRange3D object.
      Since:
      0.0.1

    • getMinLocation

      @AsOf("0.0.2") public Location getMinLocation(World world)
      Returns the minimum location within the range. The minimum location is defined by the minimum X, Y and Z coordinates.
      Parameters:
      world - The world in which the location is.
      Returns:
      The minimum location within the range.
      Since:
      0.0.1

    • getMaxLocation

      @AsOf("0.0.2") public Location getMaxLocation(World world)
      Returns the maximum location within the range. The maximum location is defined by the maximum X, Y and Z coordinates.
      Parameters:
      world - The world in which the location is.
      Returns:
      The maximum location within the range.
      Since:
      0.0.1

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

    • minX

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

    • maxX

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

    • minY

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

    • maxY

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

    • minZ

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

    • maxZ

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