Package io.codemine.java.postgresql.codecs

Record Class Box

java.lang.Object
java.lang.Record
io.codemine.java.postgresql.codecs.Box
public record Box(double x1, double y1, double x2, double y2) extends Record
PostgreSQL box type. A rectangular box defined by upper-right (x1, y1) and lower-left (x2, y2) corners.

PostgreSQL normalizes box coordinates so that (x1, y1) is always the upper-right corner and (x2, y2) is always the lower-left corner. Use of(double, double, double, double) to create a normalized box from arbitrary corner coordinates.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Box(double x1, double y1, double x2, double y2)
    Creates an instance of a Box record class.

  • 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.
    static Box
    of(double x1, double y1, double x2, double y2)
    Creates a normalized box where (x1, y1) is upper-right and (x2, y2) is lower-left, matching PostgreSQL's canonical ordering.
    String
    toString()
    Returns a string representation of this record class.
    double
    x1()
    Returns the value of the x1 record component.
    double
    x2()
    Returns the value of the x2 record component.
    double
    y1()
    Returns the value of the y1 record component.
    double
    y2()
    Returns the value of the y2 record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Box

      public Box(double x1, double y1, double x2, double y2)
      Creates an instance of a Box record class.
      Parameters:
      x1 - the value for the x1 record component
      y1 - the value for the y1 record component
      x2 - the value for the x2 record component
      y2 - the value for the y2 record component

  • Method Details

    • of

      public static Box of(double x1, double y1, double x2, double y2)
      Creates a normalized box where (x1, y1) is upper-right and (x2, y2) is lower-left, matching PostgreSQL's canonical ordering.

    • 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

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

    • x1

      public double x1()
      Returns the value of the x1 record component.
      Returns:
      the value of the x1 record component

    • y1

      public double y1()
      Returns the value of the y1 record component.
      Returns:
      the value of the y1 record component

    • x2

      public double x2()
      Returns the value of the x2 record component.
      Returns:
      the value of the x2 record component

    • y2

      public double y2()
      Returns the value of the y2 record component.
      Returns:
      the value of the y2 record component