Record Class LineString

java.lang.Object
java.lang.Record
io.micronaut.data.model.geo.LineString
Record Components:
points - the ordered points that define the line string
All Implemented Interfaces:
Geometry
@TypeDef(type=STRING, converter=GeometryJsonConverter.class) public record LineString(List<Point> points) extends Record implements Geometry
Represents a line geometry defined by an ordered list of at least two Point values.

This type follows the GeoJSON LineString model and can be converted to nested coordinate lists for serialization.

Since:
5.0

  • Constructor Details

    • LineString

      public LineString(List<Point> points)
      Creates an instance of a LineString record class.
      Parameters:
      points - the value for the points record component

  • Method Details

    • asCoords

      public List<List<Double>> asCoords()
      Returns this line string as an ordered list of point coordinate pairs.
      Returns:
      the coordinates of each point in this line string

    • fromCoords

      public static LineString fromCoords(List<List<Double>> coords)
      Creates a LineString from an ordered list of point coordinate pairs.
      Parameters:
      coords - the point coordinates to convert
      Returns:
      a line string created from the provided coordinates
      Throws:
      IllegalArgumentException - if coords is null, empty, or contains fewer than two points

    • 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 Objects::equals(Object,Object).
      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.

    • points

      public List<Point> points()
      Returns the value of the points record component.
      Returns:
      the value of the points record component