mnalis/apps-android-commons
1
0
Fork 0
mirror of https://github.com/commons-app/apps-android-commons.git synced 2025-10-26 20:33:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Added documentation

Browse source
This commit is contained in:
Agent-8 2017-12-26 12:45:05 -05:00 • committed by GitHub
parent 031855f908
commit 4e82808591
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 150 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

20
app/src/main/java/fr/free/nrw/commons/location/LatLng.java
View file

@ -3,6 +3,9 @@ package fr.free.nrw.commons.location;
import android.location.Location; import android.location.Location;
import android.support.annotation.NonNull; import android.support.annotation.NonNull;
/**
* the latitude and longitude of the user
*/
public class LatLng { public class LatLng {
private final double latitude; private final double latitude;
@ -10,7 +13,7 @@ public class LatLng {
private final float accuracy; private final float accuracy;
/** Accepts latitude and longitude. /** Accepts latitude and longitude.
* North and South values are cut off at 90° * North and South values are cut off at 90°
* *
* @param latitude double value * @param latitude double value
* @param longitude double value * @param longitude double value
@ -25,10 +28,18 @@ public class LatLng {
this.accuracy = accuracy; this.accuracy = accuracy;
} }
/**
* gets the latitude and longitude of a given non-null location
* @param location the non-null location of the user
* @return
*/
public static LatLng from(@NonNull Location location) { public static LatLng from(@NonNull Location location) {
return new LatLng(location.getLatitude(), location.getLongitude(), location.getAccuracy()); return new LatLng(location.getLatitude(), location.getLongitude(), location.getAccuracy());
} }
/**
* creates a hash code for the longitude and longitude
*/
public int hashCode() { public int hashCode() {
boolean var1 = true; boolean var1 = true;
byte var2 = 1; byte var2 = 1;
@ -39,6 +50,10 @@ public class LatLng {
return var5; return var5;
} }
/**
* checks for equality of two LatLng objects
* @param o the second LatLng object
*/
public boolean equals(Object o) { public boolean equals(Object o) {
if (this == o) { if (this == o) {
return true; return true;
@ -50,6 +65,9 @@ public class LatLng {
} }
} }
/**
* returns a string representation of the latitude and longitude
*/
public String toString() { public String toString() {
return "lat/lng: (" + this.latitude + "," + this.longitude + ")"; return "lat/lng: (" + this.latitude + "," + this.longitude + ")";
} }