Traffic tendency (#1451)

Author: vadzim-vys

CHANGELOG.md

@@ -4,6 +4,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 ### main
 - Fixed `RouteOptions#toUrl` for a case when `RouteOptions` was deserialized from a json generated by an old version of mapbox-java. [#1447](https://github.com/mapbox/mapbox-java/pull/1447)
+- Added traffic tendency annotations. [#1451](https://github.com/mapbox/mapbox-java/pull/1451)
 
 ### v6.5.0 - May 25, 2022
 - No additional changes

samples/build.gradle

@@ -30,6 +30,6 @@ dependencies {
 
 buildConfig {
     packageName = 'com.mapbox.sample'
-    buildConfigField 'String', 'MAPBOX_ACCESS_TOKEN', System.getenv("MAPBOX_ACCESS_TOKEN")
+    buildConfigField 'String', 'MAPBOX_ACCESS_TOKEN', project.hasProperty('MAPBOX_ACCESS_TOKEN') ? project.property('MAPBOX_ACCESS_TOKEN') : System.getenv('MAPBOX_ACCESS_TOKEN')
 }
 

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

@@ -1,5 +1,6 @@
 package com.mapbox.api.directions.v5;
 
+import androidx.annotation.IntDef;
 import androidx.annotation.StringDef;
 
 import java.lang.annotation.Retention;
@@ -143,6 +144,12 @@ public final class DirectionsCriteria {
    */
   public static final String ANNOTATION_CLOSURE = "closure";
 
+  /**
+   * The tendency value conveys the changing
+   * state of traffic congestion (increasing, decreasing, constant etc).
+   */
+  public static final String ANNOTATION_TRAFFIC_TENDENCY = "traffic_tendency";
+
   /**
    * Exclude all tolls along the returned directions route.
    *
@@ -270,6 +277,36 @@ public final class DirectionsCriteria {
    */
   public static final String APPROACH_CURB = "curb";
 
+  /***
+   * Conveys the changing state of traffic congestion: unknown.
+   */
+  public static final int TRAFFIC_TENDENCY_UNKNOWN = 0;
+
+  /***
+   * Conveys the changing state of traffic congestion: constant.
+   */
+  public static final int TRAFFIC_TENDENCY_CONSTANT_CONGESTION = 1;
+
+  /***
+   * Conveys the changing state of traffic congestion: increasing.
+   */
+  public static final int TRAFFIC_TENDENCY_INCREASING_CONGESTION = 2;
+
+  /***
+   * Conveys the changing state of traffic congestion: decreasing.
+   */
+  public static final int TRAFFIC_TENDENCY_DECREASING_CONGESTION = 3;
+
+  /***
+   * Conveys the changing state of traffic congestion: rapidly increasing.
+   */
+  public static final int TRAFFIC_TENDENCY_RAPIDLY_INCREASING_CONGESTION = 4;
+
+  /***
+   * Conveys the changing state of traffic congestion: rapidly decreasing.
+   */
+  public static final int TRAFFIC_TENDENCY_RAPIDLY_DECREASING_CONGESTION = 5;
+
   private DirectionsCriteria() {
     //not called
   }
@@ -329,7 +366,8 @@ private DirectionsCriteria() {
     ANNOTATION_CONGESTION,
     ANNOTATION_CONGESTION_NUMERIC,
     ANNOTATION_MAXSPEED,
-    ANNOTATION_CLOSURE
+    ANNOTATION_CLOSURE,
+    ANNOTATION_TRAFFIC_TENDENCY
   })
   public @interface AnnotationCriteria {
   }
@@ -417,4 +455,22 @@ private DirectionsCriteria() {
   })
   public @interface ApproachesCriteria {
   }
+
+  /**
+   * Retention policy for the traffic tendency annotations.
+   * The tendency value conveys the changing state of traffic
+   * congestion (increasing, decreasing, constant etc). New values
+   * could be introduced in the future without an API version change.
+   */
+  @Retention(RetentionPolicy.CLASS)
+  @IntDef({
+    TRAFFIC_TENDENCY_UNKNOWN,
+    TRAFFIC_TENDENCY_CONSTANT_CONGESTION,
+    TRAFFIC_TENDENCY_INCREASING_CONGESTION,
+    TRAFFIC_TENDENCY_DECREASING_CONGESTION,
+    TRAFFIC_TENDENCY_RAPIDLY_INCREASING_CONGESTION,
+    TRAFFIC_TENDENCY_RAPIDLY_DECREASING_CONGESTION
+  })
+  public @interface TrafficTendencyCriteria {
+  }
 }

services-directions-models/src/main/java/com/mapbox/api/directions/v5/models/LegAnnotation.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;
@@ -92,6 +93,17 @@ public static Builder builder() {
   @SerializedName("congestion_numeric")
   public abstract List<Integer> congestionNumeric();
 
+  /**
+   * The traffic tendency between each pair of coordinates.
+   * @return a list of {@link Integer} where each value matches
+   *   {@link DirectionsCriteria.TrafficTendencyCriteria}. The tendency value conveys the changing
+   *   state of traffic congestion (increasing, decreasing, constant etc). New values
+   *   could be introduced in the future without an API version change.
+   */
+  @Nullable
+  @SerializedName("traffic_tendency")
+  public abstract List<Integer> trafficTendency();
+
   /**
    * 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
@@ -196,12 +208,22 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
      */
     public abstract Builder congestionNumeric(@Nullable List<Integer> congestionNumeric);
 
+    /**
+     * The traffic tendency between each pair of coordinates.
+     * @param trafficTendency is a list of {@link Integer} where each value matches
+     *   {@link DirectionsCriteria.TrafficTendencyCriteria}. The tendency value conveys the changing
+     *   state of traffic congestion (increasing, decreasing, constant etc).
+     */
+    @NonNull
+    public abstract Builder trafficTendency(@Nullable List<Integer> trafficTendency);
+
     /**
      * Build a new {@link LegAnnotation} object.
      *
      * @return a new {@link LegAnnotation} using the provided values in this builder
      * @since 3.0.0
      */
     public abstract LegAnnotation build();
+
   }
 }

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

@@ -348,6 +348,7 @@ public List<Integer> layersList() {
    * {@link DirectionsCriteria#ANNOTATION_CONGESTION_NUMERIC}
    * {@link DirectionsCriteria#ANNOTATION_MAXSPEED}
    * {@link DirectionsCriteria#ANNOTATION_CLOSURE}
+   * {@link DirectionsCriteria#ANNOTATION_TRAFFIC_TENDENCY}
    * See the {@link RouteLeg} object for more details on what is included with annotations.
    * <p>
    * Must be used in conjunction with {@link DirectionsCriteria#OVERVIEW_FULL}
@@ -368,6 +369,7 @@ public List<Integer> layersList() {
    * {@link DirectionsCriteria#ANNOTATION_CONGESTION_NUMERIC}
    * {@link DirectionsCriteria#ANNOTATION_MAXSPEED}
    * {@link DirectionsCriteria#ANNOTATION_CLOSURE}
+   * {@link DirectionsCriteria#ANNOTATION_TRAFFIC_TENDENCY}
    * See the {@link RouteLeg} object for more details on what is included with annotations.
    * <p>
    * Must be used in conjunction with {@link DirectionsCriteria#OVERVIEW_FULL}
@@ -1391,6 +1393,7 @@ public abstract Builder overview(
      * {@link DirectionsCriteria#ANNOTATION_CONGESTION_NUMERIC}
      * {@link DirectionsCriteria#ANNOTATION_MAXSPEED}
      * {@link DirectionsCriteria#ANNOTATION_CLOSURE}
+     * {@link DirectionsCriteria#ANNOTATION_TRAFFIC_TENDENCY}
      * See the {@link RouteLeg} object for more details on what is included with annotations.
      * <p>
      * Must be used in conjunction with {@link DirectionsCriteria#OVERVIEW_FULL}
@@ -1412,6 +1415,7 @@ public abstract Builder overview(
      * {@link DirectionsCriteria#ANNOTATION_CONGESTION_NUMERIC}
      * {@link DirectionsCriteria#ANNOTATION_MAXSPEED}
      * {@link DirectionsCriteria#ANNOTATION_CLOSURE}
+     * {@link DirectionsCriteria#ANNOTATION_TRAFFIC_TENDENCY}
      * See the {@link RouteLeg} object for more details on what is included with annotations.
      * <p>
      * Must be used in conjunction with {@link DirectionsCriteria#OVERVIEW_FULL}

services-directions-refresh-models/src/test/java/com.mapbox.api.directionsrefresh.v1.models/DirectionsRefreshResponseTest.java

@@ -38,6 +38,7 @@ public void testSerialization() throws IOException {
     assertNotNull(directionsRefreshResponse.route().legs().get(0).annotation());
     assertTrue(directionsRefreshResponse.route().legs().get(0).annotation().congestion().size() > 0);
     assertTrue(directionsRefreshResponse.route().legs().get(0).incidents().size() > 0);
+    assertTrue(directionsRefreshResponse.route().legs().get(0).annotation().trafficTendency().size() > 0);
   }
 
   @Test

services-directions-refresh-models/src/test/java/com.mapbox.api.directionsrefresh.v1.models/DirectionsRouteRefreshTest.java

@@ -35,6 +35,7 @@ public void testSerialization() throws IOException {
     assertNotNull(directionsRouteRefresh.legs().get(0).annotation().congestion());
     assertNotNull(directionsRouteRefresh.legs().get(0).incidents());
     assertTrue(directionsRouteRefresh.legs().get(0).incidents().size() > 0);
+    assertTrue(directionsRouteRefresh.legs().get(0).annotation().trafficTendency().size() > 0);
   }
 
   @Test

services-directions-refresh-models/src/test/java/com.mapbox.api.directionsrefresh.v1.models/RouteLegRefreshTest.java

@@ -3,6 +3,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 
+import com.mapbox.api.directions.v5.DirectionsCriteria;
 import com.mapbox.api.directions.v5.models.Congestion;
 import com.mapbox.api.directions.v5.models.Incident;
 import com.mapbox.api.directions.v5.models.LegAnnotation;
@@ -70,6 +71,14 @@ public void fromJson() {
       0.1,
       10.2
     );
+    List<Integer> trafficTendency = Arrays.asList(
+      DirectionsCriteria.TRAFFIC_TENDENCY_UNKNOWN,
+      DirectionsCriteria.TRAFFIC_TENDENCY_CONSTANT_CONGESTION,
+      DirectionsCriteria.TRAFFIC_TENDENCY_INCREASING_CONGESTION,
+      DirectionsCriteria.TRAFFIC_TENDENCY_DECREASING_CONGESTION,
+      DirectionsCriteria.TRAFFIC_TENDENCY_RAPIDLY_INCREASING_CONGESTION,
+      DirectionsCriteria.TRAFFIC_TENDENCY_RAPIDLY_DECREASING_CONGESTION
+    );
 
     List<Incident> incidents = Arrays.asList(
       Incident.builder()
@@ -110,6 +119,7 @@ public void fromJson() {
           .duration(durations)
           .maxspeed(maxSpeeds)
           .speed(speeds)
+          .trafficTendency(trafficTendency)
           .build()
       )
       .incidents(incidents)
@@ -123,4 +133,22 @@ public void fromJson() {
     assertEquals(routeLegRefresh, fromJson);
   }
 
+  @Test
+  public void trafficTendencyFromJson() {
+    String json = "{\"traffic_tendency\": [0,1,2,3,4,5]}";
+    LegAnnotation expectedAnnotations = LegAnnotation.builder()
+      .trafficTendency(Arrays.asList(
+        DirectionsCriteria.TRAFFIC_TENDENCY_UNKNOWN,
+        DirectionsCriteria.TRAFFIC_TENDENCY_CONSTANT_CONGESTION,
+        DirectionsCriteria.TRAFFIC_TENDENCY_INCREASING_CONGESTION,
+        DirectionsCriteria.TRAFFIC_TENDENCY_DECREASING_CONGESTION,
+        DirectionsCriteria.TRAFFIC_TENDENCY_RAPIDLY_INCREASING_CONGESTION,
+        DirectionsCriteria.TRAFFIC_TENDENCY_RAPIDLY_DECREASING_CONGESTION
+      ))
+      .build();
+
+    LegAnnotation fromJson = LegAnnotation.fromJson(json);
+
+    assertEquals(expectedAnnotations, fromJson);
+  }
 }