NAVAND-713: added LegAnnotation.Builder#unrecognizedProperties

Author: dzinad

CHANGELOG.md

@@ -4,6 +4,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 ### main
 - Added `unrecognized()` to `DirectionsRefreshJsonObject` so that unrecognized properties can be received from refresh response.
+- Added `LegAnnotation.Builder#unrecognizedProperties`.
 
 ### v6.8.0 - September 29, 2022
 - Replaced `TurfSimplify#simplify` with `TurfTransformation#simplify`. [#1496](https://github.com/mapbox/mapbox-java/pull/1496)

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

@@ -5,11 +5,17 @@
 import com.google.auto.value.AutoValue;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonPrimitive;
 import com.google.gson.TypeAdapter;
 import com.google.gson.annotations.SerializedName;
 import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
+import com.mapbox.auto.value.gson.SerializableJsonElement;
 
+import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 
 /**
  * An annotations object that contains additional details about each line segment along the route
@@ -219,6 +225,28 @@ public abstract static class Builder extends DirectionsJsonObject.Builder<Builde
     @NonNull
     public abstract Builder trafficTendency(@Nullable List<Integer> trafficTendency);
 
+    /**
+     * Use this method to add parameters which are not present in the model yet but are supported
+     * on the Directions API side in the response.
+     * Use it for experimental parameters.
+     *
+     * @param unrecognizedProperties parameters to add to request
+     */
+    @NonNull
+    public Builder unrecognizedProperties(
+      @Nullable Map<String, JsonElement> unrecognizedProperties
+    ) {
+      if (unrecognizedProperties == null) {
+        return unrecognized(null);
+      } else {
+        Map<String, SerializableJsonElement> map = new HashMap<>();
+        for (String key : unrecognizedProperties.keySet()) {
+          map.put(key, new SerializableJsonElement(unrecognizedProperties.get(key)));
+        }
+        return unrecognized(map);
+      }
+    }
+
     /**
      * Build a new {@link LegAnnotation} object.
      *

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

@@ -3,12 +3,16 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 
+import com.google.gson.JsonElement;
+import com.google.gson.JsonPrimitive;
 import com.mapbox.core.TestUtils;
 import org.junit.Test;
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 public class LegAnnotationTest extends TestUtils {
 
@@ -20,12 +24,15 @@ public void sanity() throws Exception {
       .distance(new ArrayList<Double>())
       .duration(new ArrayList<Double>())
       .speed(new ArrayList<Double>())
+      .unrecognizedProperties(new HashMap<>())
       .build();
     assertNotNull(annotation);
   }
 
   @Test
   public void testSerializable() throws Exception {
+    Map<String, JsonElement> unrecognizedProperties = new HashMap<>();
+    unrecognizedProperties.put("aaa", new JsonPrimitive("bbb"));
     List<Double> distance = new ArrayList<>();
     distance.add(20d);
     distance.add(40d);
@@ -36,13 +43,16 @@ public void testSerializable() throws Exception {
       .distance(distance)
       .duration(new ArrayList<Double>())
       .speed(new ArrayList<Double>())
+      .unrecognizedProperties(unrecognizedProperties)
       .build();
     byte[] serialized = TestUtils.serialize(annotation);
     assertEquals(annotation, deserialize(serialized, LegAnnotation.class));
   }
 
   @Test
   public void testToFromJson1() {
+    Map<String, JsonElement> unrecognizedProperties = new HashMap<>();
+    unrecognizedProperties.put("aaa", new JsonPrimitive("bbb"));
 
     List<Double> distanceList = Arrays.asList(
       4.294596842089401,
@@ -101,6 +111,7 @@ public void testToFromJson1() {
       .duration(durationList)
       .speed(speedList)
       .congestion(congestionList)
+      .unrecognizedProperties(unrecognizedProperties)
       .build();