RouteOptions: added max_weight (#1439)

Author: RingerJK

CHANGELOG.md

@@ -3,6 +3,7 @@
 Mapbox welcomes participation and contributions from everyone.
 
 ### main
+- Added `max_weight` field to `RouteOptions` to provide max vehicle weight, metric tons. [#1439](https://github.com/mapbox/mapbox-java/pull/1439)
 
 ### v6.5.0-beta.5 - May 11, 2022
 - Added `TollCollection#name` field which contains a name of the toll booth/gantry, when available. [#1432](https://github.com/mapbox/mapbox-java/pull/1432)

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

@@ -798,6 +798,17 @@ public List<Boolean> snappingIncludeClosuresList() {
   @Nullable
   public abstract Double maxWidth();
 
+  /**
+   * The max vehicle weight, in metric tons (1000 kg). If this parameter is provided,
+   * the Directions API will compute a route that includes only roads with a weight limit greater
+   * than or equal to the max vehicle weight. max_weight must be between 0 and 100 metric tons.
+   * <p>
+   * The default value is 2.5 metric tons.
+   */
+  @SerializedName("max_weight")
+  @Nullable
+  public abstract Double maxWeight();
+
   /**
    * Whether the routes should be refreshable via the directions refresh API.
    * <p>
@@ -950,6 +961,7 @@ public URL toUrl(@NonNull String accessToken) {
     appendQueryParameter(sb, "depart_at", departAt());
     appendQueryParameter(sb, "max_height", maxHeight());
     appendQueryParameter(sb, "max_width", maxWidth());
+    appendQueryParameter(sb, "max_weight", maxWeight());
     appendQueryParameter(sb, "metadata", metadata());
 
     Map<String, SerializableJsonElement> unrecognized = unrecognized();
@@ -1888,6 +1900,19 @@ public Builder snappingIncludeClosuresList(@Nullable List<Boolean> snappingClosu
     @NonNull
     public abstract Builder maxWidth(@Nullable @FloatRange(from = 0, to = 10) Double maxWidth);
 
+    /**
+     * The max vehicle weight, in metric tons (1000 kg). If this parameter is provided,
+     * the Directions API will compute a route that includes only roads with a weight limit greater
+     * than or equal to the max vehicle weight. max_weight must be between 0 and 100 metric tons.
+     * <p>
+     * The default value is 2.5 metric tons.
+     *
+     * @param maxWeight max vehicle weight, in tons. Must be between 0 and 100.
+     * @return this builder
+     */
+    @NonNull
+    public abstract Builder maxWeight(@Nullable @FloatRange(from = 0, to = 100) Double maxWeight);
+
     /**
      * Whether the routes should be refreshable via the directions refresh API.
      * <p>

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

@@ -32,7 +32,7 @@ public class RouteOptionsTest extends TestUtils {
    */
   private static final String ROUTE_OPTIONS_JSON = "route_options_v5.json";
   private static final String ROUTE_OPTIONS_URL =
-    "https://api.mapbox.com/directions/v5/mapbox/driving/-122.4003312,37.7736941;-122.4187529,37.7689715;-122.4255172,37.7775835?access_token=pk.token&geometries=polyline6&alternatives=false&overview=full&radiuses=%3Bunlimited%3B5.1&steps=true&avoid_maneuver_radius=200.0&bearings=0%2C90%3B90%2C0%3B&layers=-42%3B%3B0&continue_straight=false&annotations=congestion%2Cdistance%2Cduration&language=ru&roundabout_exits=false&voice_instructions=true&banner_instructions=true&voice_units=metric&exclude=toll%2Cferry%2Cpoint%2811.0+-22.0%29&include=hot%2Chov2&approaches=%3Bcurb%3B&waypoints=0%3B1%3B2&waypoint_names=%3BSerangoon+Garden+Market+%26+Food+Centre%3BFunky+%26nAmE*&waypoint_targets=%3B12.2%2C21.2%3B&enable_refresh=true&walking_speed=5.11&walkway_bias=-0.2&alley_bias=0.75&snapping_include_closures=%3Bfalse%3Btrue&arrive_by=2021-01-01%27T%2701%3A01&depart_at=2021-02-02%27T%2702%3A02&max_height=1.5&max_width=1.4&metadata=true";
+    "https://api.mapbox.com/directions/v5/mapbox/driving/-122.4003312,37.7736941;-122.4187529,37.7689715;-122.4255172,37.7775835?access_token=pk.token&geometries=polyline6&alternatives=false&overview=full&radiuses=%3Bunlimited%3B5.1&steps=true&avoid_maneuver_radius=200.0&bearings=0%2C90%3B90%2C0%3B&layers=-42%3B%3B0&continue_straight=false&annotations=congestion%2Cdistance%2Cduration&language=ru&roundabout_exits=false&voice_instructions=true&banner_instructions=true&voice_units=metric&exclude=toll%2Cferry%2Cpoint%2811.0+-22.0%29&include=hot%2Chov2&approaches=%3Bcurb%3B&waypoints=0%3B1%3B2&waypoint_names=%3BSerangoon+Garden+Market+%26+Food+Centre%3BFunky+%26nAmE*&waypoint_targets=%3B12.2%2C21.2%3B&enable_refresh=true&walking_speed=5.11&walkway_bias=-0.2&alley_bias=0.75&snapping_include_closures=%3Bfalse%3Btrue&arrive_by=2021-01-01%27T%2701%3A01&depart_at=2021-02-02%27T%2702%3A02&max_height=1.5&max_width=1.4&max_weight=2.9&metadata=true";
   private static final String ACCESS_TOKEN = "pk.token";
 
   private final String optionsJson = loadJsonFixture(ROUTE_OPTIONS_JSON);
@@ -309,6 +309,13 @@ public void maxWidthIsValid_fromJson() {
     assertEquals(1.4, options.maxWidth(), 0.000001);
   }
 
+  @Test
+  public void maxWeightIsValid_fromJson() {
+    RouteOptions options = RouteOptions.fromJson(optionsJson);
+
+    assertEquals(2.9, options.maxWeight(), 0.000001);
+  }
+
   @Test
   public void enableRefreshIsValid_fromJson() {
     RouteOptions options = RouteOptions.fromJson(optionsJson);
@@ -759,6 +766,7 @@ private RouteOptions routeOptions() {
       .departAt("2021-02-02'T'02:02")
       .maxHeight(1.5)
       .maxWidth(1.4)
+      .maxWeight(2.9)
       .snappingIncludeClosures(";false;true")
       .user(DirectionsCriteria.PROFILE_DEFAULT_USER)
       .enableRefresh(true)
@@ -846,6 +854,7 @@ private RouteOptions routeOptionsList() {
       .departAt("2021-02-02'T'02:02")
       .maxHeight(1.5)
       .maxWidth(1.4)
+      .maxWeight(2.9)
       .snappingIncludeClosuresList(new ArrayList<Boolean>() {{
         add(null);
         add(false);

services-directions-models/src/test/resources/route_options_v5.json

@@ -32,6 +32,7 @@
   "depart_at": "2021-02-02'T'02:02",
   "max_height": 1.5,
   "max_width": 1.4,
+  "max_weight": 2.9,
   "enable_refresh": true,
   "metadata": true
 }

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

@@ -95,6 +95,7 @@ Call<DirectionsResponse> getCall(
     @Query("depart_at") String departAt,
     @Query("max_height") Double maxHeight,
     @Query("max_width") Double maxWidth,
+    @Query("max_weight") Double maxWeight,
     @Query("metadata") Boolean metadata
   );
 
@@ -177,6 +178,7 @@ Call<DirectionsResponse> postCall(
     @Field("depart_at") String departAt,
     @Field("max_height") Double maxHeight,
     @Field("max_width") Double maxWidth,
+    @Field("max_weight") Double maxWeight,
     @Field("metadata") Boolean metadata
   );
 }

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

@@ -107,6 +107,7 @@ private Call<DirectionsResponse> get() {
       routeOptions().departAt(),
       routeOptions().maxHeight(),
       routeOptions().maxWidth(),
+      routeOptions().maxWeight(),
       routeOptions().metadata()
     );
   }
@@ -148,6 +149,7 @@ private Call<DirectionsResponse> post() {
       routeOptions().departAt(),
       routeOptions().maxHeight(),
       routeOptions().maxWidth(),
+      routeOptions().maxWeight(),
       routeOptions().metadata()
     );
   }

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

@@ -754,6 +754,17 @@ public void max_width() throws Exception {
       mapboxDirections.cloneCall().request().url().queryParameter("max_width"));
   }
 
+  @Test
+  public void max_weight() throws Exception {
+    MapboxDirections mapboxDirections = MapboxDirections.builder()
+      .accessToken("token")
+      .routeOptions(routeOptions.toBuilder().baseUrl(mockUrl.toString()).build())
+      .build();
+
+    assertEquals("2.9",
+      mapboxDirections.cloneCall().request().url().queryParameter("max_weight"));
+  }
+
   @Test
   public void enable_refresh() throws Exception {
     MapboxDirections mapboxDirections = MapboxDirections.builder()

services-directions/src/test/resources/route_options_v5.json

@@ -32,6 +32,7 @@
   "depart_at": "2021-02-02'T'02:02",
   "max_height": 1.5,
   "max_width": 1.4,
+  "max_weight": 2.9,
   "enable_refresh": true,
   "metadata": true
 }