Package org.opensearch.common.geo.builders

Class CoordinatesBuilder

java.lang.Object
org.opensearch.common.geo.builders.CoordinatesBuilder
public class CoordinatesBuilder extends Object
A builder for a list of coordinates. Enables chaining of individual coordinates either as long/lat pairs or as Coordinate elements, arrays or collections.
Opensearch.internal:

  • Constructor Details

    • CoordinatesBuilder

      public CoordinatesBuilder()

  • Method Details

    • coordinate

      public CoordinatesBuilder coordinate(org.locationtech.jts.geom.Coordinate coordinate)
      Add a new coordinate to the collection
      Parameters:
      coordinate - the coordinate to add
      Returns:
      this

    • coordinate

      public CoordinatesBuilder coordinate(double longitude, double latitude)
      Add a new coordinate to the collection
      Parameters:
      longitude - longitude of the coordinate
      latitude - latitude of the coordinate
      Returns:
      this

    • coordinates

      public CoordinatesBuilder coordinates(org.locationtech.jts.geom.Coordinate... coordinates)
      Add an array of coordinates to the current coordinates
      Parameters:
      coordinates - array of Coordinates to add
      Returns:
      this

    • coordinates

      public CoordinatesBuilder coordinates(Collection<? extends org.locationtech.jts.geom.Coordinate> coordinates)
      Add a collection of coordinates to the current coordinates
      Parameters:
      coordinates - collection of Coordinates to add
      Returns:
      this

    • close

      public CoordinatesBuilder close()
      Makes a closed ring out of the current coordinates by adding the starting point as the end point. Will have no effect of starting and end point are already the same coordinate.

    • build

      public List<org.locationtech.jts.geom.Coordinate> build()
      Returns:
      a list containing the current coordinates