com.mapbox.services.commons.models

Class Position

java.lang.Object

com.mapbox.services.commons.models.Position

public class Position
extends java.lang.Object

Represents a position defined by a longitude, latitude, and optionally, an altitude.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
static Position	fromCoordinates(double[] coordinates)
static Position	fromCoordinates(double longitude, double latitude) Builds a Position from a double longitude and latitude.
static Position	fromCoordinates(double longitude, double latitude, double altitude) Builds a Position from a double longitude, latitude and an altitude.
static Position	fromLngLat(double longitude, double latitude) Builds a Position from a double longitude and latitude.
double	getAltitude() Gets the position's altitude.
double[]	getCoordinates() Gets the position coordinates in a double array.
double	getLatitude() Gets the position's latitude.
double	getLongitude() Gets the position's longitude.
boolean	hasAltitude() Checks if a position has an altitude value.
java.lang.String	toString() Use to print out the longitude, latitude and altitude values.

Methods inherited from class java.lang.Object

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

Method Detail

getLongitude

public double getLongitude()

Gets the position's longitude.

Returns:

double value with positions longitude.

Since:

1.0.0

getLatitude

public double getLatitude()

Gets the position's latitude.

Returns:

double value with positions latitude.

Since:

1.0.0

getAltitude

public double getAltitude()

Gets the position's altitude.

Returns:

double value with positions altitude.

Since:

1.0.0

getCoordinates

public double[] getCoordinates()

Gets the position coordinates in a double array. Altitude will be included in the array if a value is present.

Returns:

double[] array with longitude, latitude, and altitude (if present).

Since:

1.0.0

fromCoordinates

public static Position fromCoordinates(double longitude,
                                       double latitude,
                                       double altitude)

Builds a Position from a double longitude, latitude and an altitude.

Parameters:

longitude - double longitude value.

latitude - double latitude value.

altitude - double altitude value.

Returns:

Position.

Since:

1.0.0

fromCoordinates

public static Position fromCoordinates(double longitude,
                                       double latitude)

Builds a Position from a double longitude and latitude.

Parameters:

longitude - double longitude value.

latitude - double latitude value.

Returns:

Position.

Since:

1.0.0

fromCoordinates

public static Position fromCoordinates(double[] coordinates)

fromLngLat

public static Position fromLngLat(double longitude,
                                  double latitude)

Builds a Position from a double longitude and latitude. Identical to fromCoordinates(double, double) but more explicit about the right order for the longitude and latitude parameters.

Parameters:

longitude - double longitude value.

latitude - double latitude value.

Returns:

Position.

Since:

2.0.0

hasAltitude

public boolean hasAltitude()

Checks if a position has an altitude value.

Returns:

true if position contains altitude data.

Since:

1.0.0

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object.

Returns:

true if the position matches the object, false otherwise.

Since:

1.3.0

toString

public java.lang.String toString()

Use to print out the longitude, latitude and altitude values.

Overrides:

toString in class java.lang.Object

Returns:

String containing the longitude, latitude, and altitude.

Since:

1.3.0