API to access unrecognized fields (#1416)

Author: vadzim-vys

CHANGELOG.md

@@ -3,7 +3,8 @@
 Mapbox welcomes participation and contributions from everyone.
 
 ### main
-- Added roundtrip of unrecognized JSON properties [#1394](https://github.com/mapbox/mapbox-java/pull/1394)
+- Added roundtrip of unrecognized JSON properties. [#1394](https://github.com/mapbox/mapbox-java/pull/1394)
+- Added API to access unrecognized JSON properties. See `#getUnrecognizedProperty` and `#getUnrecognizedPropertiesNames` in each Directions API model object.  [#1416](https://github.com/mapbox/mapbox-java/pull/1416)
 
 ### v6.4.1 - April 22, 2022
 - Added correct escaping for `<white space>&<white space>` pattern in query parameters for `RouteOptions#toUrl`. [#1410](https://github.com/mapbox/mapbox-java/pull/1410).

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

@@ -3,14 +3,17 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
 import com.mapbox.api.directions.v5.DirectionsAdapterFactory;
 import com.mapbox.geojson.Point;
 import com.mapbox.geojson.PointAsCoordinatesTypeAdapter;
 import com.mapbox.auto.value.gson.SerializableJsonElement;
 import com.mapbox.auto.value.gson.UnrecognizedJsonProperties;
 
 import java.io.Serializable;
+import java.util.Collections;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * Provides a base class for Directions model classes.
@@ -33,6 +36,41 @@ public String toJson() {
     return gson.create().toJson(this);
   }
 
+  /**
+   * Use this method to access a JSON property that wasn't recognized during JSON serialization.
+   * This may be useful to access experimental properties.
+   * @param propertyName name of a json property
+   * @return value of a requested property or null if the requested property doesn't exist.
+   */
+  @Nullable
+  public final JsonElement getUnrecognizedProperty(String propertyName) {
+    JsonElement result = null;
+    Map<String, SerializableJsonElement> unrecognizedProperties = unrecognized();
+    if (unrecognizedProperties != null) {
+      SerializableJsonElement property = unrecognizedProperties.get(propertyName);
+      if (property != null) {
+        result = property.getElement();
+      }
+    }
+    return result;
+  }
+
+  /**
+   * Use this method to get names of unrecognized JSON properties.
+   * @return names of unrecognized JSON properties or an empty set
+   */
+  @NonNull
+  public final Set<String> getUnrecognizedPropertiesNames() {
+    Set<String> result;
+    Map<String, SerializableJsonElement> unrecognizedProperties = unrecognized();
+    if (unrecognizedProperties != null) {
+      result = unrecognizedProperties.keySet();
+    } else {
+      result = Collections.emptySet();
+    }
+    return result;
+  }
+
   @Nullable
   @UnrecognizedJsonProperties
   abstract Map<String, SerializableJsonElement> unrecognized();

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

@@ -2,7 +2,6 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonPrimitive;
@@ -16,11 +15,13 @@
 import org.junit.Test;
 
 import java.util.ArrayList;
-import java.util.Map;
+import java.util.Set;
 
 import static com.mapbox.api.directions.v5.utils.MutateJsonUtil.mutateJson;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
 
 public class DirectionsResponseTest extends TestUtils {
 
@@ -72,6 +73,49 @@ public void testToFromJsonWithMutatedResponse() throws Exception {
     assertEquals(mutatedJson, jsonFromObject);
   }
 
+  @Test
+  public void accessUnrecognizedProperties() throws Exception {
+    JsonObject directionsResponseJson = readJsonObject(DIRECTIONS_V5_PRECISION6_FIXTURE_ARTIFICIAL_FIELDS);
+    String unrecognizedPropertyName = "testUnrecognizedProperty";
+    String unrecognizedPropertyValue = "test";
+    directionsResponseJson.add(unrecognizedPropertyName, new JsonPrimitive(unrecognizedPropertyValue));
+    DirectionsResponse response = DirectionsResponse.fromJson(directionsResponseJson.toString());
+
+    String value = response.getUnrecognizedProperty(unrecognizedPropertyName).getAsString();
+    JsonElement notExistingProperty = response.getUnrecognizedProperty("notExisting");
+
+    assertEquals(unrecognizedPropertyValue, value);
+    assertNull(notExistingProperty);
+  }
+
+  @Test
+  public void noUnrecognizedProperties() throws Exception {
+    JsonObject directionsResponseJson = readJsonObject(DIRECTIONS_V5_PRECISION6_FIXTURE_ARTIFICIAL_FIELDS);
+    DirectionsResponse response = DirectionsResponse.fromJson(directionsResponseJson.toString());
+
+    JsonElement value = response.getUnrecognizedProperty("");
+    Set<String> propertiesNames = response.getUnrecognizedPropertiesNames();
+
+    assertNull(value);
+    assertEquals(0, propertiesNames.size());
+  }
+
+  @Test
+  public void getUnrecognizedPropertiesNames() throws Exception {
+    JsonObject directionsResponseJson = readJsonObject(DIRECTIONS_V5_PRECISION6_FIXTURE_ARTIFICIAL_FIELDS);
+    directionsResponseJson.add("1", new JsonPrimitive(1));
+    directionsResponseJson.add("2", new JsonPrimitive(2));
+    directionsResponseJson.add("3", new JsonPrimitive(3));
+    DirectionsResponse response = DirectionsResponse.fromJson(directionsResponseJson.toString());
+
+    Set<String> properties = response.getUnrecognizedPropertiesNames();
+
+    assertEquals(3, properties.size());
+    assertTrue(properties.contains("1"));
+    assertTrue(properties.contains("2"));
+    assertTrue(properties.contains("3"));
+  }
+
   @Test
   public void fromJson_correctlyBuildsFromJsonWithOptionsAndUuid() throws Exception {
     String json = loadJsonFixture(DIRECTIONS_V5_PRECISION6_FIXTURE);
@@ -158,4 +202,9 @@ public void fromToJsonForRouteWithSilentWaypoints() throws IOException {
 
     assertEquals(initial, deserialized);
   }
+
+  private JsonObject readJsonObject(String file) throws IOException {
+    Gson gson = new GsonBuilder().create();
+    return gson.fromJson(loadJsonFixture(file), JsonObject.class);
+  }
 }