NAVAND-1547: new annotations (#1567)

Author: VysotskiVadim

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

@@ -152,6 +152,17 @@ public final class DirectionsCriteria {
   @SuppressWarnings("checkstyle:javadocvariable")
   public static final String ANNOTATION_TRAFFIC_TENDENCY = "traffic_tendency";
 
+  /**
+   * The freeflow value conveys the typical speed at low traffic times of day
+   * such as nights or early mornings.
+   */
+  public static final String ANNOTATION_FREEFLOW_SPEED = "freeflow_speed";
+
+  /**
+   * The current speed value conveys the instantaneous (at the time of the request) speed.
+   */
+  public static final String ANNOTATION_CURRENT_SPEED = "current_speed";
+
   /**
    * Exclude all tolls along the returned directions route.
    *
@@ -528,7 +539,9 @@ private DirectionsCriteria() {
     ANNOTATION_CONGESTION_NUMERIC,
     ANNOTATION_MAXSPEED,
     ANNOTATION_CLOSURE,
-    ANNOTATION_TRAFFIC_TENDENCY
+    ANNOTATION_TRAFFIC_TENDENCY,
+    ANNOTATION_CURRENT_SPEED,
+    ANNOTATION_FREEFLOW_SPEED
   })
   public @interface AnnotationCriteria {
   }

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

@@ -105,6 +105,30 @@ public static Builder builder() {
   @SerializedName("traffic_tendency")
   public abstract List<Integer> trafficTendency();
 
+  /**
+   * The speed may be either a positive integer in kilometers per hour
+   * or `null` where attribution is missing.
+   * The freeflow value conveys the typical speed at low traffic times of day
+   * such as nights or early mornings.
+   * Available only for `mapbox/driving` and `mapbox/driving-traffic` profiles.
+   * @return The freeflow speed for each line segment along the route geometry.
+   */
+  @Nullable
+  @SerializedName("freeflow_speed")
+  public abstract List<Integer> freeflowSpeed();
+
+  /**
+   * The speed may be either a positive integer in kilometers per hour
+   * or `null` where attribution is missing.
+   * The current speed value conveys the instantaneous
+   * (at the time of the request) speed.
+   * Available only for `mapbox/driving` and `mapbox/driving-traffic` profiles.
+   * @return The current speed for each line segment along the route geometry.
+   */
+  @Nullable
+  @SerializedName("current_speed")
+  public abstract List<Integer> currentSpeed();
+
   /**
    * Convert the current {@link LegAnnotation} to its builder holding the currently assigned
    * values. This allows you to modify a single property and then rebuild the object resulting in
@@ -219,6 +243,24 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
     @NonNull
     public abstract Builder trafficTendency(@Nullable List<Integer> trafficTendency);
 
+    /**
+     * @param freeflowSpeed speed for each line segment along the route geometry.
+     *   The speed may be either a positive integer in kilometers per hour or
+     *   `null` where attribution is missing.
+     * @return this builder for chaining options together
+     */
+    @NonNull
+    public abstract Builder freeflowSpeed(@Nullable List<Integer> freeflowSpeed);
+
+    /**
+     * @param currentSpeed The current speed for each line segment along the route geometry.
+     *   The speed may be either a positive integer in kilometers per hour
+     *   or `null` where attribution is missing.
+     * @return this builder for chaining options together
+     */
+    @NonNull
+    public abstract Builder currentSpeed(@Nullable List<Integer> currentSpeed);
+
     /**
      * Build a new {@link LegAnnotation} object.
      *

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

@@ -1,5 +1,6 @@
 package com.mapbox.api.directions.v5.models;
 
+import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 
@@ -8,11 +9,14 @@
 import com.mapbox.core.TestUtils;
 import org.junit.Test;
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Scanner;
 
 public class LegAnnotationTest extends TestUtils {
 
@@ -105,12 +109,36 @@ public void testToFromJson1() {
         0,
         0);
 
+    List<Integer> freeflowSpeed = Arrays.asList(
+      0,
+      1,
+      2,
+      3,
+      4,
+      null,
+      0,
+      9
+    );
+
+    List<Integer> currentSpeed = Arrays.asList(
+      0,
+      4,
+      2,
+      7,
+      4,
+      null,
+      0,
+      2
+    );
+
     LegAnnotation annotation = LegAnnotation.builder()
       .congestionNumeric(congestionNumericList)
       .distance(distanceList)
       .duration(durationList)
       .speed(speedList)
       .congestion(congestionList)
+      .freeflowSpeed(freeflowSpeed)
+      .currentSpeed(currentSpeed)
       .unrecognizedJsonProperties(unrecognizedProperties)
       .build();
 
@@ -120,4 +148,35 @@ public void testToFromJson1() {
 
     assertEquals(annotation, annotationFromJson);
   }
+
+  @Test
+  public void testExampleResponse() throws IOException {
+    String responseString = loadJsonFixture("directions_freeflow_speed_and_current_speed_annotations.json");
+    DirectionsResponse response = DirectionsResponse.fromJson(responseString);
+
+    List<Integer> freeflowSpeed = response.routes().get(0).legs().get(0).annotation().freeflowSpeed();
+    assertEquals(341, freeflowSpeed.size());
+    assertEquals((Integer) 11, freeflowSpeed.get(0));
+    assertEquals(null, freeflowSpeed.get(24));
+    assertEquals((Integer) 27, freeflowSpeed.get(113));
+    assertEquals((Integer) 8, freeflowSpeed.get(340));
+
+    List<Integer> currentSpeed = response.routes().get(0).legs().get(0).annotation().currentSpeed();
+    assertEquals(341, currentSpeed.size());
+    assertEquals(null, currentSpeed.get(0));
+    assertEquals((Integer) 5, currentSpeed.get(33));
+    assertEquals((Integer) 9, currentSpeed.get(317));
+    assertEquals(null, currentSpeed.get(340));
+  }
+
+  protected String loadJsonFixture(String filename) throws IOException {
+    InputStream inputStream = getResourceInputSteam(filename);
+    Scanner scanner = new Scanner(inputStream, UTF_8.name()).useDelimiter("\\A");
+    return scanner.hasNext() ? scanner.next() : "";
+  }
+
+  private InputStream getResourceInputSteam(String filename) {
+    ClassLoader classLoader = getClass().getClassLoader();
+    return classLoader.getResourceAsStream(filename);
+  }
 }