MapboxStreetsV8 and isUrban fields (#1182)

Author: korshaknn

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

@@ -0,0 +1,91 @@
+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.google.gson.annotations.SerializedName;
+import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+import com.mapbox.api.directions.v5.DirectionsCriteria;
+
+/**
+ * An object containing detailed information about the road exiting the intersection along the
+ * route.
+ * Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+ */
+@AutoValue
+public abstract class MapboxStreetsV8 extends DirectionsJsonObject {
+
+  /**
+   * Class of the road exiting the intersection.
+   *
+   * @return class of the road.
+   */
+  @Nullable
+  @SerializedName("class")
+  public abstract String roadClass();
+
+  /**
+   * 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_MapboxStreetsV8.Builder();
+  }
+
+  /**
+   * Convert the current {@link MapboxStreetsV8} 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 MapboxStreetsV8}.
+   *
+   * @return a {@link Builder} with the same values set to match the ones defined in this {@link
+   * MapboxStreetsV8}
+   */
+  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<MapboxStreetsV8> typeAdapter(Gson gson) {
+    return new AutoValue_MapboxStreetsV8.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 MapboxStreetsV8 fromJson(String json) {
+    GsonBuilder gson = new GsonBuilder();
+    gson.registerTypeAdapterFactory(DirectionsAdapterFactory.create());
+    return gson.create().fromJson(json, MapboxStreetsV8.class);
+  }
+
+  /**
+   * This builder can be used to set the values describing the {@link MapboxStreetsV8}.
+   */
+  @AutoValue.Builder
+  public abstract static class Builder {
+
+    /**
+     * Class of the road exiting the intersection.
+     *
+     * @param roadClass class of the road exiting the intersection.
+     * @return this builder for chaining options together
+     */
+    public abstract Builder roadClass(@Nullable String roadClass);
+
+    /**
+     * Build a new {@link MapboxStreetsV8} object.
+     *
+     * @return a new {@link MapboxStreetsV8} using the provided values in this builder
+     */
+    public abstract MapboxStreetsV8 build();
+  }
+}

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

@@ -8,6 +8,7 @@
 import com.google.gson.TypeAdapter;
 import com.google.gson.annotations.SerializedName;
 import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+import com.mapbox.api.directions.v5.DirectionsCriteria;
 import com.mapbox.geojson.Point;
 
 import java.util.List;
@@ -146,6 +147,28 @@ public Point location() {
   @SerializedName("geometry_index")
   public abstract Integer geometryIndex();
 
+  /**
+   * A boolean indicating whether the road exiting the intersection is considered to be in an urban
+   * area. This value is determined by the density of the surrounding road network.
+   * Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+   *
+   * @return a value indicating whether the road exiting the intersection is in an urban area
+   */
+  @Nullable
+  @SerializedName("is_urban")
+  public abstract Boolean isUrban();
+
+  /**
+   * 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()}
+   * specification. Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+   *
+   * @return an object containing detailed road information.
+   */
+  @Nullable
+  @SerializedName("mapbox_streets_v8")
+  public abstract MapboxStreetsV8 mapboxStreetsV8();
+
   /**
    * Convert the current {@link StepIntersection} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -284,6 +307,28 @@ public abstract static class Builder {
      */
     public abstract Builder geometryIndex(@Nullable Integer geometryIndex);
 
+    /**
+     * A boolean indicating whether the road exiting the intersection is considered to be in an
+     * urban area. This value is determined by the density of the surrounding road network.
+     * Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+     *
+     * @param isUrban indicating whether the road exiting the intersection is in an urban area
+     * @return this builder for chaining options together
+     */
+    @Nullable
+    public abstract Builder isUrban(@Nullable Boolean isUrban);
+
+    /**
+     * 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()}
+     * specification. Only available on the {@link DirectionsCriteria#PROFILE_DRIVING} profile.
+     *
+     * @param street an object containing detailed road information.
+     * @return this builder for chaining options together
+     */
+    @Nullable
+    public abstract Builder mapboxStreetsV8(@Nullable MapboxStreetsV8 street);
+
     /**
      * The rawLocation as a double array. Once the {@link StepIntersection} object's created,
      * this raw location gets converted into a {@link Point} object and is public exposed as such.

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

@@ -0,0 +1,52 @@
+package com.mapbox.api.directions.v5.models;
+
+import com.mapbox.core.TestUtils;
+import org.junit.Assert;
+import org.junit.Test;
+
+import static junit.framework.TestCase.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+
+public class MapboxStreetsV8Test extends TestUtils {
+  @Test
+  public void sanity() {
+    assertNotNull(buildDefaultStreet());
+  }
+
+  @Test
+  public void testSerializable() throws Exception {
+    MapboxStreetsV8 street = buildDefaultStreet();
+    byte[] serialized = TestUtils.serialize(street);
+    assertEquals(street, deserialize(serialized, MapboxStreetsV8.class));
+  }
+
+  @Test
+  public void testFromJson() {
+    String streetJsonString = "{"
+        + "\"class\": \"street\""
+        + "}";
+
+    MapboxStreetsV8 street = MapboxStreetsV8.fromJson(streetJsonString);
+    Assert.assertEquals("street", street.roadClass());
+
+    String jsonStr = street.toJson();
+    compareJson(streetJsonString, jsonStr);
+  }
+
+  @Test
+  public void testToFromJson() {
+    MapboxStreetsV8 street = buildDefaultStreet();
+
+    String jsonString = street.toJson();
+    MapboxStreetsV8 streetFromJson = MapboxStreetsV8.fromJson(jsonString);
+
+    Assert.assertEquals(street, streetFromJson);
+  }
+
+  private MapboxStreetsV8 buildDefaultStreet() {
+    return MapboxStreetsV8.builder()
+        .roadClass("street")
+        .build();
+  }
+}

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

@@ -2,6 +2,7 @@
 
 import static junit.framework.TestCase.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
 
 import com.mapbox.core.TestUtils;
 import com.mapbox.geojson.Point;
@@ -45,6 +46,8 @@ public void testToFromJson1() {
       .rawLocation(new double[]{13.426579, 52.508068})
       .tunnelName("test tunnel")
       .geometryIndex(123)
+      .isUrban(true)
+      .mapboxStreetsV8(MapboxStreetsV8.builder().roadClass("street").build())
       .build();
 
     String jsonString = intersection.toJson();
@@ -62,6 +65,7 @@ public void testToFromJson2() {
       .bearings(Arrays.asList(120, 210, 300))
       .rawLocation(new double[]{13.424671, 52.508812})
       .tunnelName("test tunnel")
+      .mapboxStreetsV8(MapboxStreetsV8.builder().roadClass("street").build())
       .build();
 
     String jsonString = intersection.toJson();
@@ -73,14 +77,22 @@ public void testToFromJson2() {
 
   @Test
   public void testFromJson() {
-    String stepIntersectionJsonString = "{\"out\": 0, \"entry\": [true], \"bearings\": [ 125 ], "
+    String stepIntersectionJsonString = "{"
+    + "\"location\": [ 13.426579, 52.508068 ],"
+    + "\"bearings\": [ 125 ], "
+    + "\"entry\": [true], "
+    + "\"out\": 0, "
     + "\"tunnel_name\": \"test tunnel name\","
     + "\"geometry_index\": 123,"
-    + "\"location\": [ 13.426579, 52.508068 ] }";
+    + "\"is_urban\": true,"
+    + "\"mapbox_streets_v8\": {\"class\": \"street\"}"
+    + "}";
 
     StepIntersection stepIntersection = StepIntersection.fromJson(stepIntersectionJsonString);
     Assert.assertEquals("test tunnel name", stepIntersection.tunnelName());
     Assert.assertEquals(123, stepIntersection.geometryIndex().intValue());
+    assertTrue(stepIntersection.isUrban());
+    assertEquals("street", stepIntersection.mapboxStreetsV8().roadClass());
 
     Point location = stepIntersection.location();
     Assert.assertEquals(13.426579, location.longitude(), 0.0001);