Package org.elasticsearch.common.geo.builders

Class CoordinatesBuilder

java.lang.Object

org.elasticsearch.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.

Constructor Summary

Constructors

Constructor	Description
CoordinatesBuilder()

Method Summary

Modifier and Type	Method	Description
List<Coordinate>	build()
CoordinatesBuilder	close()	Makes a closed ring out of the current coordinates by adding the starting point as the end point.
CoordinatesBuilder	coordinate(double longitude, double latitude)	Add a new coordinate to the collection
CoordinatesBuilder	coordinate(Coordinate coordinate)	Add a new coordinate to the collection
CoordinatesBuilder	coordinates(Collection<? extends Coordinate> coordinates)	Add a collection of coordinates to the current coordinates
CoordinatesBuilder	coordinates(Coordinate... coordinates)	Add an array of coordinates to the current coordinates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoordinatesBuilder

public CoordinatesBuilder()

Method Detail

coordinate

public CoordinatesBuilder coordinate(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(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 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<Coordinate> build()

Returns:

a list containing the current coordinates