org.imperiumlabs.geofirestore

Class GeoLocation

java.lang.Object

org.imperiumlabs.geofirestore.GeoLocation

public final class GeoLocation
extends java.lang.Object

A wrapper class for location coordinates.

Field Summary

Fields

Modifier and Type	Field and Description
double	latitude The latitude of this location in the range of [-90, 90]
double	longitude The longitude of this location in the range of [-180, 180]

Constructor Summary

Constructors

Constructor and Description
GeoLocation(double latitude, double longitude) Creates a new GeoLocation with the given latitude and longitude.

Method Summary

Modifier and Type	Method and Description
static boolean	coordinatesValid(double latitude, double longitude) Checks if these coordinates are valid geo coordinates.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

latitude

public final double latitude

The latitude of this location in the range of [-90, 90]

longitude

public final double longitude

The longitude of this location in the range of [-180, 180]

Constructor Detail

GeoLocation

public GeoLocation(double latitude,
                   double longitude)

Creates a new GeoLocation with the given latitude and longitude.

Parameters:

latitude - The latitude in the range of [-90, 90]

longitude - The longitude in the range of [-180, 180]

Throws:

java.lang.IllegalArgumentException - If the coordinates are not valid geo coordinates

Method Detail

coordinatesValid

public static boolean coordinatesValid(double latitude,
                                       double longitude)

Checks if these coordinates are valid geo coordinates.

Parameters:

latitude - The latitude must be in the range [-90, 90]

longitude - The longitude must be in the range [-180, 180]

Returns:

True if these are valid geo coordinates

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object