adds optional geometry precsion param to some methods (#411)

* adds optional geometry precsion param to some methods

* fixed checkstyle issue

* removed static import

Author: Cameron Mace

mapbox/libandroid-services/gradle-javadoc.gradle

@@ -12,7 +12,6 @@ android.libraryVariants.all { variant ->
         options.bottom("© 2015–2016 Mapbox. All rights reserved.")
         options.links("http://docs.oracle.com/javase/7/docs/api/")
         options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-        options.overview("src/main/java/overview.html")
         exclude '**/R.java', '**/BuildConfig.java'
     }
 }

mapbox/libandroid-telemetry/gradle-javadoc.gradle

@@ -12,7 +12,6 @@ android.libraryVariants.all { variant ->
         options.bottom("© 2015–2016 Mapbox. All rights reserved.")
         options.links("http://docs.oracle.com/javase/7/docs/api/")
         options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-        options.overview("src/main/java/overview.html")
         exclude '**/R.java', '**/BuildConfig.java'
     }
 }

mapbox/libandroid-ui/gradle-javadoc.gradle

@@ -5,14 +5,13 @@ android.libraryVariants.all { variant ->
         failOnError = false
         destinationDir = new File(destinationDir, variant.baseName)
         source = files(variant.javaCompile.source)
-        classpath = files(variant.javaCompile.classpath.files) + files(android.bootClasspath) + files("../../../../libjava/lib/src/main/java")
+        classpath = files(variant.javaCompile.classpath.files) + files(android.bootClasspath)
         options.windowTitle("Mapbox Android Services SDK $VERSION_NAME Reference")
         options.docTitle("Mapbox Android Services SDK $VERSION_NAME")
         options.header("Mapbox Android Services SDK $VERSION_NAME Reference")
         options.bottom("© 2015–2016 Mapbox. All rights reserved.")
         options.links("http://docs.oracle.com/javase/7/docs/api/")
         options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-        options.overview("src/main/java/overview.html")
         exclude '**/R.java', '**/BuildConfig.java'
     }
 }

mapbox/libjava-core/gradle-javadoc.gradle

@@ -8,5 +8,4 @@ task javadocGeneration(type: Javadoc) {
     options.bottom("© 2015–2016 Mapbox. All rights reserved.")
     options.links("http://docs.oracle.com/javase/7/docs/api/")
     options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-    options.overview("src/main/java/overview.html")
 }

mapbox/libjava-geojson/gradle-javadoc.gradle

@@ -8,5 +8,4 @@ task javadocGeneration(type: Javadoc) {
     options.bottom("© 2015–2016 Mapbox. All rights reserved.")
     options.links("http://docs.oracle.com/javase/7/docs/api/")
     options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-    options.overview("src/main/java/overview.html")
 }

mapbox/libjava-services-rx/gradle-javadoc.gradle

@@ -8,5 +8,4 @@ task javadocGeneration(type: Javadoc) {
     options.bottom("© 2015–2016 Mapbox. All rights reserved.")
     options.links("http://docs.oracle.com/javase/7/docs/api/")
     options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-    options.overview("src/main/java/overview.html")
 }

mapbox/libjava-services/gradle-javadoc.gradle

@@ -8,5 +8,4 @@ task javadocGeneration(type: Javadoc) {
     options.bottom("© 2015–2016 Mapbox. All rights reserved.")
     options.links("http://docs.oracle.com/javase/7/docs/api/")
     options.linksOffline("http://d.android.com/reference/", "$System.env.ANDROID_HOME/docs/reference")
-    options.overview("src/main/java/overview.html")
 }

mapbox/libjava-services/src/main/java/com/mapbox/services/api/navigation/v5/RouteUtils.java

@@ -21,7 +21,7 @@
 
 /**
  * A few utilities to work with RouteLeg objects.
- *
+ * <p>
  * This is an experimental API. Experimental APIs are quickly evolving and
  * might change or be removed in minor versions.
  *
@@ -93,7 +93,7 @@ public boolean isInStep(Position position, RouteLeg routeLeg, int stepIndex) thr
    * @throws TurfException     signals that a Turf exception of some sort has occurred.
    * @since 1.3.0
    */
-  public double getDistanceToStep(Position position, RouteLeg routeLeg, int stepIndex) throws ServicesException,
+  public static double getDistanceToStep(Position position, RouteLeg routeLeg, int stepIndex) throws ServicesException,
     TurfException {
     Position closestPoint = getSnapToRoute(position, routeLeg, stepIndex);
     return TurfMeasurement.distance(
@@ -136,12 +136,31 @@ public static double getDistanceToNextStep(Position position, RouteLeg routeLeg,
    * @since 2.0.0
    */
   public static double getDistanceToNextStep(Position position, RouteLeg routeLeg, int stepIndex, String units)
-    throws ServicesException,
-    TurfException {
+    throws ServicesException, TurfException {
+    return getDistanceToNextStep(position, routeLeg, stepIndex, units, Constants.PRECISION_6);
+  }
+
+  /**
+   * Measures the distance from a position to the end of the route step. The position provided is snapped to the route
+   * before distance is calculated.
+   *
+   * @param position          you want to measure distance to from route. If using for navigation, this would typically
+   *                          be the users current location.
+   * @param routeLeg          a directions route.
+   * @param stepIndex         integer index for step in route.
+   * @param geometryPrecision either {@link Constants#PRECISION_5} or {@link Constants#PRECISION_6}
+   * @return double value giving distance in kilometers.
+   * @throws ServicesException if error occurs Mapbox API related.
+   * @throws TurfException     signals that a Turf exception of some sort has occurred.
+   * @since 2.1.0
+   */
+  public static double getDistanceToNextStep(Position position, RouteLeg routeLeg, int stepIndex, String units,
+                                             int geometryPrecision)
+    throws ServicesException, TurfException {
     LegStep step = validateStep(routeLeg, stepIndex);
 
     // Decode the geometry
-    List<Position> coords = PolylineUtils.decode(step.getGeometry(), Constants.PRECISION_6);
+    List<Position> coords = PolylineUtils.decode(step.getGeometry(), geometryPrecision);
 
     LineString slicedLine = TurfMisc.lineSlice(
       Point.fromCoordinates(position),
@@ -160,8 +179,22 @@ public static double getDistanceToNextStep(Position position, RouteLeg routeLeg,
    * @since 2.0.0
    */
   public static double getDistanceToEndOfRoute(Position position, DirectionsRoute route) throws TurfException {
+    return getDistanceToEndOfRoute(position, route, Constants.PRECISION_6);
+  }
+
+  /**
+   * @param position          you want to measure distance to from route. If using for navigation, this would typically
+   *                          be the users current location.
+   * @param route             a {@link DirectionsRoute}.
+   * @param geometryPrecision either {@link Constants#PRECISION_5} or {@link Constants#PRECISION_6}
+   * @return double value giving distance in kilometers.
+   * @throws TurfException signals that a Turf exception of some sort has occurred.
+   * @since 2.1.0
+   */
+  public static double getDistanceToEndOfRoute(Position position, DirectionsRoute route, int geometryPrecision)
+    throws TurfException {
     // Decode the geometry
-    List<Position> coords = PolylineUtils.decode(route.getGeometry(), Constants.PRECISION_6);
+    List<Position> coords = PolylineUtils.decode(route.getGeometry(), geometryPrecision);
 
     LineString slicedLine = TurfMisc.lineSlice(
       Point.fromCoordinates(position),
@@ -184,11 +217,29 @@ public static double getDistanceToEndOfRoute(Position position, DirectionsRoute
    * @since 1.3.0
    */
   public static Position getSnapToRoute(Position position, RouteLeg routeLeg, int stepIndex)
+    throws ServicesException, TurfException {
+    return getSnapToRoute(position, routeLeg, stepIndex, Constants.PRECISION_6);
+  }
+
+  /**
+   * Snaps given position to a {@link RouteLeg} step.
+   *
+   * @param position          that you want to snap to routeLeg. If using for navigation, this would
+   *                          typically be the users current location.
+   * @param routeLeg          that you want to snap position to.
+   * @param stepIndex         integer index for step in routeLeg.
+   * @param geometryPrecision either {@link Constants#PRECISION_5} or {@link Constants#PRECISION_6}
+   * @return your position snapped to the route.
+   * @throws ServicesException if error occurs Mapbox API related.
+   * @throws TurfException     signals that a Turf exception of some sort has occurred.
+   * @since 2.1.0
+   */
+  public static Position getSnapToRoute(Position position, RouteLeg routeLeg, int stepIndex, int geometryPrecision)
     throws ServicesException, TurfException {
     LegStep step = validateStep(routeLeg, stepIndex);
 
     // Decode the geometry
-    List<Position> coords = PolylineUtils.decode(step.getGeometry(), Constants.PRECISION_6);
+    List<Position> coords = PolylineUtils.decode(step.getGeometry(), geometryPrecision);
 
     // No need to do the math if the step has one coordinate only
     if (coords.size() == 1) {
@@ -234,7 +285,7 @@ public boolean isOffRoute(Position position, RouteLeg routeLeg) throws ServicesE
    * @throws TurfException     signals that a Turf exception of some sort has occurred.
    * @since 1.3.0
    */
-  public int getClosestStep(Position position, RouteLeg routeLeg) throws TurfException, ServicesException {
+  public static int getClosestStep(Position position, RouteLeg routeLeg) throws TurfException, ServicesException {
     double minDistance = Double.MAX_VALUE;
     int closestIndex = 0;
 
@@ -262,18 +313,35 @@ public int getClosestStep(Position position, RouteLeg routeLeg) throws TurfExcep
    * @since 2.0.0
    */
   public static LineString getGeometryRemainingOnRoute(Position position, DirectionsRoute route) throws TurfException {
+    return getGeometryRemainingOnRoute(position, route, Constants.PRECISION_6);
+  }
+
+  /**
+   * Get the remaining route geometry from the position provided to the end of the directions route. This is useful
+   * when the user location is traversing along the route and you don't want the past route geometry to show on the map.
+   *
+   * @param position          the new starting postion of the route geometry. If using for navigation, this would
+   *                          typically be the users current location.
+   * @param route             a Directions route.
+   * @param geometryPrecision either {@link Constants#PRECISION_5} or {@link Constants#PRECISION_6}
+   * @return the {@link LineString} representing the new route geometry.
+   * @throws TurfException signals that a Turf exception of some sort has occurred.
+   * @since 2.1.0
+   */
+  public static LineString getGeometryRemainingOnRoute(Position position, DirectionsRoute route, int geometryPrecision)
+    throws TurfException {
     int lastLegIndex = route.getLegs().size() - 1;
     int lastStepIndex = route.getLegs().get(lastLegIndex).getSteps().size() - 1;
 
     String polyline = route.getLegs().get(lastLegIndex).getSteps().get(lastStepIndex).getGeometry();
-    LineString lastStepInLastLegLineString = LineString.fromPolyline(polyline, Constants.PRECISION_6);
+    LineString lastStepInLastLegLineString = LineString.fromPolyline(polyline, geometryPrecision);
     int lastStepLastIndex = lastStepInLastLegLineString.getCoordinates().size() - 1;
     Position lastStepInLastLegPostion = lastStepInLastLegLineString.getCoordinates().get(lastStepLastIndex);
 
     return TurfMisc.lineSlice(
       Point.fromCoordinates(position),
       Point.fromCoordinates(lastStepInLastLegPostion),
-      LineString.fromPolyline(route.getGeometry(), Constants.PRECISION_6)
+      LineString.fromPolyline(route.getGeometry(), geometryPrecision)
     );
   }