expose toll collection

Author: Łukasz Paczos

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

@@ -171,6 +171,20 @@ public Point location() {
   @SerializedName("rest_stop")
   public abstract RestStop restStop();
 
+  /**
+   * An object containing information about a toll collection point along the route.
+   * This is a payment booth or overhead electronic gantry
+   * <a href="https://wiki.openstreetmap.org/wiki/Tag:barrier%3Dtoll_booth">
+   *   payment booth or overhead electronic gantry</a>
+   * where toll charge is collected.
+   * Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+   *
+   * @return an object containing information about a toll collection point along the route.
+   */
+  @Nullable
+  @SerializedName("toll_collection")
+  public abstract TollCollection tollCollection();
+
   /**
    * An object containing detailed information about the road exiting the intersection along the
    * route. Properties in this object correspond to properties in the {@link #classes()}
@@ -344,6 +358,20 @@ public abstract static class Builder {
     @Nullable
     public abstract Builder restStop(@Nullable RestStop restStop);
 
+    /**
+     * An object containing information about a toll collection point along the route.
+     * This is a payment booth or overhead electronic gantry
+     * <a href="https://wiki.openstreetmap.org/wiki/Tag:barrier%3Dtoll_booth">
+     *   payment booth or overhead electronic gantry</a>
+     * where toll charge is collected.
+     *
+     * @param tollCollection object containing information about
+     *                       a toll collection point along the route.
+     * @return this builder for chaining options together
+     */
+    @Nullable
+    public abstract Builder tollCollection(@Nullable TollCollection tollCollection);
+
     /**
      * An object containing detailed information about the road exiting the intersection along the
      * route. Properties in this object correspond to properties in the {@link #classes()}

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

@@ -0,0 +1,92 @@
+package com.mapbox.api.directions.v5.models;
+
+import androidx.annotation.Nullable;
+
+import com.google.auto.value.AutoValue;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.TypeAdapter;
+import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+import com.mapbox.api.directions.v5.DirectionsCriteria;
+
+/**
+ * An object containing information about a toll collection point along the route.
+ * This is a payment booth or overhead electronic gantry
+ * <a href="https://wiki.openstreetmap.org/wiki/Tag:barrier%3Dtoll_booth">
+ *   payment booth or overhead electronic gantry</a>
+ * where toll charge is collected.
+ * Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+ */
+@AutoValue
+public abstract class TollCollection extends DirectionsJsonObject {
+
+  /**
+   * The type of toll collection point, either `toll_booth` or `toll_gantry`.
+   * Note that adding new possible types is not considered a breaking change.
+   */
+  @Nullable
+  public abstract String type();
+
+  /**
+   * Create a new instance of this class by using the {@link Builder} class.
+   *
+   * @return this classes {@link Builder} for creating a new instance
+   */
+  public static Builder builder() {
+    return new AutoValue_TollCollection.Builder();
+  }
+
+  /**
+   * Convert the current {@link TollCollection} to its builder holding the currently assigned
+   * values. This allows you to modify a single property and then rebuild the object resulting in
+   * an updated and modified {@link TollCollection}.
+   *
+   * @return a {@link Builder} with the same values set to match the ones defined in this {@link
+   * TollCollection}
+   */
+  public abstract Builder toBuilder();
+
+  /**
+   * Gson type adapter for parsing Gson to this class.
+   *
+   * @param gson the built {@link Gson} object
+   * @return the type adapter for this class
+   */
+  public static TypeAdapter<TollCollection> typeAdapter(Gson gson) {
+    return new AutoValue_TollCollection.GsonTypeAdapter(gson);
+  }
+
+  /**
+   * Create a new instance of this class by passing in a formatted valid JSON String.
+   *
+   * @param json a formatted valid JSON string defining an Incident
+   * @return a new instance of this class defined by the values passed in the method
+   */
+  public static TollCollection fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
+    return gson.create().fromJson(json, TollCollection.class);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link TollCollection}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder {
+
+    /**
+     * The type of toll collection point, either `toll_booth` or `toll_gantry`.
+     * Note that adding new possible types is not considered a breaking change.
+     *
+     * @param type toll collection type
+     */
+    public abstract Builder type(@Nullable String type);
+
+    /**
+     * Build a new {@link TollCollection} object.
+     *
+     * @return a new {@link TollCollection} using the provided values in this builder
+     */
+    public abstract TollCollection build();
+  }
+}

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

@@ -47,6 +47,7 @@ public void testToFromJson1() {
       .geometryIndex(123)
       .isUrban(true)
       .restStop(RestStop.builder().type("rest_area").build())
+      .tollCollection(TollCollection.builder().type("toll_gantry").build())
       .adminIndex(2)
       .mapboxStreetsV8(MapboxStreetsV8.builder().roadClass("street").build())
       .build();
@@ -128,4 +129,18 @@ public void testRestStop() {
     String jsonStr = stepIntersection.toJson();
     compareJson(stepIntersectionJsonString, jsonStr);
   }
+
+  @Test
+  public void testTollCollection() {
+    String stepIntersectionJsonString = "{"
+    + "\"location\": [ 13.426579, 52.508068 ],"
+    + "\"toll_collection\": { \"type\": \"toll_gantry\" }"
+    + "}";
+
+    StepIntersection stepIntersection = StepIntersection.fromJson(stepIntersectionJsonString);
+
+    Assert.assertEquals("toll_gantry", stepIntersection.tollCollection().type());
+    String jsonStr = stepIntersection.toJson();
+    compareJson(stepIntersectionJsonString, jsonStr);
+  }
 }