com.couchbase.client.java.util

Class Coordinate

java.lang.Object

com.couchbase.client.java.util.Coordinate

public class Coordinate
extends Object

A coordinate is a tuple of a latitude and a longitude.

To create a new instance:

 Coordinate eiffelTower = Coordinate.lat(48.858093).lon(2.294694);
 

Or, if you prefer to specify longitude first:

 Coordinate eiffelTower = Coordinate.lon(2.294694).lat(48.858093);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Coordinate.CoordinateBuilderLatitude A staged builder that holds a coordinate's latitude value.
static class	Coordinate.CoordinateBuilderLongitude A staged builder that holds a coordinate's longitude value.

Method Summary

Modifier and Type	Method and Description
double	lat() Returns the latitude of this coordinate.
static Coordinate.CoordinateBuilderLatitude	lat(double lat) Returns a new staged Coordinate builder, with the specified latitude value.
double	lon() Returns the longitude of this coordinate.
static Coordinate.CoordinateBuilderLongitude	lon(double lon) Returns a new staged Coordinate builder, with the specified longitude value.
static Coordinate	ofLonLat(double lon, double lat) Creates a new Coordinate with a longitude and a latitude.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

ofLonLat

public static Coordinate ofLonLat(double lon,
                                  double lat)

Creates a new Coordinate with a longitude and a latitude.

To avoid confusing the order of the longitude and latitude parameters, please use lat(double) or lon(double) instead.

Parameters:

lon - the longitude of the coordinate.

lat - the latitude of the coordinate.

Returns:

a new Coordinate.

lon

public double lon()

Returns the longitude of this coordinate.

lat

public double lat()

Returns the latitude of this coordinate.

lat

@Stability.Uncommitted
public static Coordinate.CoordinateBuilderLatitude lat(double lat)

Returns a new staged Coordinate builder, with the specified latitude value.

Complete the Coordinate by calling Coordinate.CoordinateBuilderLatitude.lon(double) on the result. Example usage:

 Coordinate eiffelTower = Coordinate.lat(48.858093).lon(2.294694);
 

lon

@Stability.Uncommitted
public static Coordinate.CoordinateBuilderLongitude lon(double lon)

Returns a new staged Coordinate builder, with the specified longitude value.

Complete the Coordinate by calling Coordinate.CoordinateBuilderLongitude.lat(double) on the result. Example usage:

 Coordinate eiffelTower = Coordinate.lon(2.294694).lat(48.858093);
 

toString

public String toString()

Overrides:

toString in class Object