Package com.iizix.user.geo
Class Nearby
java.lang.Object
com.iizix.user.geo.Nearby
The nearby class with locations and distance.
- Author:
- Christopher Mindus
Constructor Summary
ConstructorDescriptionNearby
(UserLocation location, double distance, boolean isElevationUsed) Constructor.Method Summary
Modifier and TypeMethodDescriptionboolean
Checks for equality.double
Gets the distance measured to the user in question.Gets the user location.boolean
Flag indicating elevation is taken into account (if present).toString()
String representation of the class.
Constructor Details
Nearby
Constructor.- Parameters:
location
- The user location.distance
- The distance in meters.isElevationUsed
- Flag indicating elevation is taken into account (if present).- Throws:
NullPointerException
- If userLocation is null.
Method Details
getUserLocationHistory
Gets the user location.- Returns:
- The user location instance.
getDistance
public double getDistance()Gets the distance measured to the user in question.- Returns:
- A distance in meters, perhaps taking into account the elevation.
isElevationUsed
public boolean isElevationUsed()Flag indicating elevation is taken into account (if present).equals
Checks for equality.toString
String representation of the class.