addSnappingClosure fun (#1253)

Author: korshaknn

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

@@ -1046,6 +1046,22 @@ public Builder waypointTargets(@NonNull List<Point> waypointTargets) {
 
     abstract Builder waypointTargets(@Nullable String waypointTargets);
 
+    /**
+     * A point to specify drop-off locations that are distinct from the locations specified in
+     * coordinates.
+     * The number of waypoint targets must be the same as the number of coordinates,
+     * but you can skip a coordinate with a null value.
+     * Must be used with steps=true.
+     *
+     * @param waypointTarget a point for drop-off locations
+     * @return this builder for chaining options together
+     * @since 4.3.0
+     */
+    public Builder addWaypointTarget(@Nullable Point waypointTarget) {
+      this.waypointTargets.add(waypointTarget);
+      return this;
+    }
+
     /**
      * A list of booleans affecting snapping of waypoint locations to road segments.
      * If true, road segments closed due to live-traffic closures will be considered for snapping.
@@ -1066,18 +1082,20 @@ public Builder snappingClosures(@NonNull List<Boolean> snappingClosures) {
     abstract Builder snappingClosures(@Nullable String snappingClosures);
 
     /**
-     * A point to specify drop-off locations that are distinct from the locations specified in
+     * A boolean affecting snapping of waypoint location to the road segment.
+     * If true, road segment closed due to live-traffic closure will be considered for snapping.
+     * If false, it will not be considered for snapping.
+     * If provided, the number of snappingClosures must be the same as the number of
      * coordinates.
-     * The number of waypoint targets must be the same as the number of coordinates,
-     * but you can skip a coordinate with a null value.
-     * Must be used with steps=true.
+     * You can skip a coordinate with null value.
+     * Must be used with {@link DirectionsCriteria#PROFILE_DRIVING_TRAFFIC}
      *
-     * @param waypointTarget a point for drop-off locations
+     * @param snappingClosure a boolean affecting snapping of waypoint location to the road segment.
      * @return this builder for chaining options together
-     * @since 4.3.0
+     * @since 5.9.0
      */
-    public Builder addWaypointTarget(@Nullable Point waypointTarget) {
-      this.waypointTargets.add(waypointTarget);
+    public Builder addSnappingClosure(@Nullable Boolean snappingClosure) {
+      this.snappingClosures.add(snappingClosure);
       return this;
     }
 

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

@@ -1436,6 +1436,45 @@ public void snappingClosuresList() throws Exception {
         mapboxDirections.cloneCall().request().url().queryParameter("snapping_include_closures"));
   }
 
+  @Test
+  public void addSnappingClosure() throws Exception {
+    MapboxDirections mapboxDirections = MapboxDirections.builder()
+        .origin(Point.fromLngLat(1.0, 1.0))
+        .destination(Point.fromLngLat(4.0, 4.0))
+        .baseUrl("https://foobar.com")
+        .accessToken(ACCESS_TOKEN)
+        .addSnappingClosure(null)
+        .addSnappingClosure(true)
+        .build();
+
+    assertNotNull(mapboxDirections);
+    assertEquals(";true",
+        mapboxDirections.cloneCall().request().url().queryParameter("snapping_include_closures"));
+  }
+
+  @Test
+  public void addSnappingClosures() throws Exception {
+    List<Boolean> snappingClosures = new ArrayList<>();
+    snappingClosures.add(false);
+    snappingClosures.add(false);
+
+    MapboxDirections mapboxDirections = MapboxDirections.builder()
+        .origin(Point.fromLngLat(1.0, 1.0))
+        .addWaypoint(Point.fromLngLat(2.0, 2.0))
+        .addWaypoint(Point.fromLngLat(2.0, 3.0))
+        .destination(Point.fromLngLat(4.0, 4.0))
+        .baseUrl("https://foobar.com")
+        .accessToken(ACCESS_TOKEN)
+        .snappingClosures(snappingClosures)
+        .addSnappingClosure(null)
+        .addSnappingClosure(true)
+        .build();
+
+    assertNotNull(mapboxDirections);
+    assertEquals("false;false;;true",
+        mapboxDirections.cloneCall().request().url().queryParameter("snapping_include_closures"));
+  }
+
   @Test
   public void snappingClosuresListNotMatchingCoordinates() throws Exception {
     thrown.expect(ServicesException.class);