Record Class Polygon

java.lang.Object
java.lang.Record
io.micronaut.data.model.geo.Polygon
Record Components:
lineStrings - the closed rings that make up the polygon
All Implemented Interfaces:
Geometry
@TypeDef(type=STRING, converter=GeometryJsonConverter.class) public record Polygon(List<LineString> lineStrings) extends Record implements Geometry
Represents a polygon defined by one or more closed LineString rings.

The first ring describes the outer boundary and any subsequent rings describe holes, matching the GeoJSON Polygon structure.

Since:
5.0

  • Constructor Details

    • Polygon

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

  • Method Details

    • asCoords

      public List<List<List<Double>>> asCoords()
      Returns this polygon as a list of ring coordinate sequences.
      Returns:
      the coordinates of each ring in this polygon

    • fromCoords

      public static Polygon fromCoords(List<List<List<Double>>> coords)
      Creates a Polygon from a list of ring coordinate sequences.
      Parameters:
      coords - the polygon ring coordinates to convert
      Returns:
      a polygon created from the provided coordinates
      Throws:
      IllegalArgumentException - if coords is null, empty, or describes an invalid polygon ring

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

    • lineStrings

      public List<LineString> lineStrings()
      Returns the value of the lineStrings record component.
      Returns:
      the value of the lineStrings record component