Added via-waypoints property (#1364)

Author: vadzim-vys

CHANGELOG.md

@@ -3,6 +3,7 @@
 Mapbox welcomes participation and contributions from everyone.
 
 ### main
+- Exposed `viaWaypoints` in `RouteLeg` [#1364](https://github.com/mapbox/mapbox-java/pull/1364)
 
 ### v6.3.0-beta.1 - January 28, 2021
 - Exposed [turf.lineIntersect](https://turfjs.org/docs/#lineIntersect) via `TurfMisc#lineIntersect` using an algorithm with O(nm) time complexity which should suite small to medium sized geometries until a more performant solution is implemented. [#1348](https://github.com/mapbox/mapbox-java/pull/1348)

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/RouteLeg.java

@@ -1,5 +1,6 @@
 package com.mapbox.api.directions.v5.models;
 
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.auto.value.AutoValue;
 import com.google.gson.Gson;
@@ -28,6 +29,17 @@ public static Builder builder() {
     return new AutoValue_RouteLeg.Builder();
   }
 
+  /**
+   * When the semicolon-separated list waypoints parameter is used in the request,
+   * an array per leg is returned that describes where a particular waypoint from
+   * the root-level array matches to the route.
+   * This provides a way for tracking when a waypoint is passed along the route.
+   * @return a list of silent waypoints
+   */
+  @Nullable
+  @SerializedName("via_waypoints")
+  public abstract List<SilentWaypoint> viaWaypoints();
+
   /**
    * The distance traveled from one waypoint to another.
    *
@@ -157,13 +169,23 @@ public static RouteLeg fromJson(String json) {
   @AutoValue.Builder
   public abstract static class Builder {
 
+    /**
+     * A list of silent waypoints which were used to request a route.
+     *
+     * @param viaWaypoints a list of silent waypoints
+     * @return this builder for chaining options together
+     */
+    @NonNull
+    public abstract Builder viaWaypoints(@Nullable List<SilentWaypoint> viaWaypoints);
+
     /**
      * The distance traveled from one waypoint to another.
      *
      * @param distance a double number with unit meters
      * @return this builder for chaining options together
      * @since 3.0.0
      */
+    @NonNull
     public abstract Builder distance(@Nullable Double distance);
 
     /**
@@ -173,6 +195,7 @@ public abstract static class Builder {
      * @return this builder for chaining options together
      * @since 1.0.0
      */
+    @NonNull
     public abstract Builder duration(@Nullable Double duration);
 
     /**
@@ -185,6 +208,7 @@ public abstract static class Builder {
      * @return this builder for chaining options together
      * @since 5.5.0
      */
+    @NonNull
     public abstract Builder durationTypical(@Nullable Double durationTypical);
 
     /**
@@ -194,6 +218,7 @@ public abstract static class Builder {
      * @return this builder for chaining options together
      * @since 3.0.0
      */
+    @NonNull
     public abstract Builder summary(@Nullable String summary);
 
     /**
@@ -204,6 +229,7 @@ public abstract static class Builder {
      * @param admins Array with admins
      * @return this builder for chaining options together
      */
+    @NonNull
     public abstract Builder admins(@Nullable List<Admin> admins);
 
     /**
@@ -213,6 +239,7 @@ public abstract static class Builder {
      * @return this builder for chaining options together
      * @since 3.0.0
      */
+    @NonNull
     public abstract Builder steps(@Nullable List<LegStep> steps);
 
     /**
@@ -221,6 +248,7 @@ public abstract static class Builder {
      * @param incidents a list of {@link Incident}
      * @return this builder for chaining options together
      */
+    @NonNull
     public abstract Builder incidents(@Nullable List<Incident> incidents);
 
     /**
@@ -232,6 +260,7 @@ public abstract static class Builder {
      * @return this builder for chaining options together
      * @since 3.0.0
      */
+    @NonNull
     public abstract Builder annotation(@Nullable LegAnnotation annotation);
 
     /**
@@ -240,6 +269,7 @@ public abstract static class Builder {
      * @param closures a list of {@link Closure}
      * @return this builder for chaining options together
      */
+    @NonNull
     public abstract Builder closures(@Nullable List<Closure> closures);
 
     /**
@@ -248,6 +278,7 @@ public abstract static class Builder {
      * @return a new {@link RouteLeg} using the provided values in this builder
      * @since 3.0.0
      */
+    @NonNull
     public abstract RouteLeg build();
   }
 }

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/SilentWaypoint.java

@@ -0,0 +1,97 @@
+package com.mapbox.api.directions.v5.models;
+
+import androidx.annotation.NonNull;
+import com.google.auto.value.AutoValue;
+import com.google.gson.Gson;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * Represents an information about silent waypoint in the leg index.
+ * See {@link RouteLeg#viaWaypoints()} for more details.
+ */
+@AutoValue
+public abstract class SilentWaypoint extends DirectionsJsonObject {
+
+  /**
+   * Create a new instance of this class by using the {@link SilentWaypoint.Builder} class.
+   *
+   * @return {@link SilentWaypoint.Builder} for creating a new instance
+   */
+  @NonNull
+  public static Builder builder() {
+    return new AutoValue_SilentWaypoint.Builder();
+  }
+
+  /**
+   * The associated waypoint index, excluding the origin (index 0) and destination.
+   *
+   * @return the associated waypoint index, excluding the origin (index 0) and destination.
+   */
+  @SerializedName("waypoint_index")
+  public abstract int waypointIndex();
+
+  /**
+   * The calculated distance, in meters, from the leg origin.
+   *
+   * @return the calculated distance, in meters, from the leg origin.
+   */
+  @SerializedName("distance_from_start")
+  public abstract double distanceFromStart();
+
+  /**
+   * The associated leg shape index of the via waypoint location.
+   *
+   * @return the associated leg shape index of the via waypoint location.
+   */
+  @SerializedName("geometry_index")
+  public abstract int geometryIndex();
+
+  /**
+   * Gson type adapter for parsing Gson to this class.
+   *
+   * @param gson the built {@link Gson} object
+   * @return the type adapter for this class
+   */
+  @NonNull
+  public static TypeAdapter<SilentWaypoint> typeAdapter(Gson gson) {
+    return new AutoValue_SilentWaypoint.GsonTypeAdapter(gson);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link SilentWaypoint}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder {
+
+    /**
+     * @param waypointIndex the associated waypoint index, excluding
+     *   the origin (index 0) and destination.
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder waypointIndex(int waypointIndex);
+
+    /**
+     * @param distanceFromStart the calculated distance, in meters, from the leg origin.
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder distanceFromStart(double distanceFromStart);
+
+    /**
+     * @param geometryIndex the associated leg shape index of the via waypoint location.
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder geometryIndex(int geometryIndex);
+
+    /**
+     * Build a new {@link SilentWaypoint} object.
+     *
+     * @return a new {@link SilentWaypoint} object
+     */
+    @NonNull
+    public abstract SilentWaypoint build();
+  }
+}

services-directions-models/src/test/java/com/mapbox/api/directions/v5/models/DirectionsResponseTest.java

@@ -4,6 +4,8 @@
 import com.mapbox.core.TestUtils;
 import com.mapbox.geojson.Point;
 
+import java.io.IOException;
+import java.util.Arrays;
 import java.util.List;
 import org.junit.Assert;
 import org.junit.Test;
@@ -19,6 +21,7 @@ public class DirectionsResponseTest extends TestUtils {
   private static final String DIRECTIONS_V5_MULTIPLE_ROUTES = "directions_v5_multiple_routes.json";
   private static final String DIRECTIONS_V5_MULTIPLE_ROUTES_WITH_OPTIONS =
     "directions_v5_multiple_routes_with_options.json";
+  private static final String DIRECTIONS_V5_SILENT_WAYPOINT = "directions_v5_silent_waypoints.json";
 
   @Test
   public void sanity() throws Exception {
@@ -109,4 +112,30 @@ public void fromJson_deserializesOptions() throws Exception {
     assertNotNull(routes.get(0).routeOptions());
     assertNotNull(routes.get(1).routeOptions());
   }
+
+  @Test
+  public void fromJson_deserializeWiaWaypoints() throws IOException {
+    String json = loadJsonFixture(DIRECTIONS_V5_SILENT_WAYPOINT);
+
+    DirectionsRoute route = DirectionsResponse.fromJson(json).routes().get(0);
+
+    List<SilentWaypoint> viaWaypoints = route.legs().get(0).viaWaypoints();
+    assertNotNull(viaWaypoints);
+    assertEquals(1, viaWaypoints.size());
+    SilentWaypoint waypoint = viaWaypoints.get(0);
+    assertEquals(1, waypoint.waypointIndex());
+    assertEquals(616.839, waypoint.distanceFromStart(), 0.001);
+    assertEquals(58, waypoint.geometryIndex());
+  }
+
+  @Test
+  public void fromToJsonForRouteWithSilentWaypoints() throws IOException {
+    String json = loadJsonFixture(DIRECTIONS_V5_SILENT_WAYPOINT);
+
+    DirectionsResponse initial = DirectionsResponse.fromJson(json);
+    String serialized = initial.toJson();
+    DirectionsResponse deserialized = DirectionsResponse.fromJson(serialized);
+
+    assertEquals(initial, deserialized);
+  }
 }