Record Class Point

java.lang.Object
java.lang.Record
io.micronaut.data.model.geo.Point
Record Components:
x - the x-coordinate (typically longitude)
y - the y-coordinate (typically latitude)
All Implemented Interfaces:
Geometry
@TypeDef(type=STRING, converter=GeometryJsonConverter.class) public record Point(double x, double y) extends Record implements Geometry
A record that represents a two-dimensional point with x and y coordinates.

This record implements the Geometry interface and can be used in geographic data models compliant with the GeoJSON specification. The coordinates are interpreted as (longitude, latitude) or (x, y) depending on context.

Since:
5.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Point(double x, double y)
    Creates an instance of a Point record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Double>
    asCoords()
    Returns the coordinates of this point as a list of two Double values.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static Point
    fromCoords(List<Double> coords)
    Creates a Point instance from a list of coordinates.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Constructor Details

    • Point

      public Point(double x, double y)
      Creates an instance of a Point record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • asCoords

      public List<Double> asCoords()
      Returns the coordinates of this point as a list of two Double values.
      Returns:
      a list containing the x and y coordinates, in that order

    • fromCoords

      public static Point fromCoords(List<Double> coords)
      Creates a Point instance from a list of coordinates.
      Parameters:
      coords - a list containing exactly two Double elements representing x and y
      Returns:
      a new Point created from the given coordinates
      Throws:
      IllegalArgumentException - if coords is null, empty, or does not contain exactly two elements

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

    • x

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

    • y

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