package org.mongodb.morphia.geo;

Creates Point instances representing a GeoJSON
point type. The advantage of using the builder is to reduce confusion of the order of the latitude and longitude double values.

Supported by server versions 2.4 and above.
See Also:
Point/**
 * Creates Point instances representing a <a href="http://docs.mongodb.org/manual/apps/geospatial-indexes/#geojson-objects">GeoJSON</a>
 * point type. The advantage of using the builder is to reduce confusion of the order of the latitude and longitude double values.
 * <p/>
 * Supported by server versions 2.4 and above.
 *
 * @see org.mongodb.morphia.geo.Point
 */
public class PointBuilder {
    private double longitude;
    private double latitude;

    
Convenience method to return a new PointBuilder.
Returns:
a new instance of PointBuilder./**
     * Convenience method to return a new PointBuilder.
     *
     * @return a new instance of PointBuilder.
     */
    public static PointBuilder pointBuilder() {
        return new PointBuilder();
    }

    
Creates an immutable point
Returns:
the Point with the specifications from this builder./**
     * Creates an immutable point
     *
     * @return the Point with the specifications from this builder.
     */
    public Point build() {
        return new Point(latitude, longitude);
    }

    
Add a latitude.
Params:
latitude – the latitude of the point
Returns:
this PointBuilder/**
     * Add a latitude.
     *
     * @param latitude the latitude of the point
     * @return this PointBuilder
     */
    public PointBuilder latitude(final double latitude) {
        this.latitude = latitude;
        return this;
    }

    
Add a longitude.
Params:
longitude – the longitude of the point
Returns:
this PointBuilder/**
     * Add a longitude.
     *
     * @param longitude the longitude of the point
     * @return this PointBuilder
     */
    public PointBuilder longitude(final double longitude) {
        this.longitude = longitude;
        return this;
    }
}