Skip to content

Commit ce0e7d8

Browse files
author
Łukasz Paczos
committed
improve unrecognized params docs
1 parent 4fb0fb5 commit ce0e7d8

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

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

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,16 @@ public String toJson() {
3737
}
3838

3939
/**
40-
* Use this method to access a JSON property that wasn't recognized during JSON serialization.
41-
* This may be useful to access experimental properties.
40+
* Use this method to access a JSON property that wasn't recognized during JSON serialization
41+
* by the model. This may be useful to access experimental API properties.
42+
* When an experimental API property becomes stable,
43+
* it will eventually have static field in a model introduced
44+
* and it won't be available via this dynamic method anymore.
45+
*
46+
* See
47+
* <a href="https://docs.mapbox.com/api/navigation/directions/">Directions API documentation</a>
48+
* for available experimental fields.
49+
*
4250
* @param propertyName name of a json property
4351
* @return value of a requested property or null if the requested property doesn't exist.
4452
*/
@@ -56,7 +64,17 @@ public final JsonElement getUnrecognizedProperty(String propertyName) {
5664
}
5765

5866
/**
59-
* Use this method to get names of unrecognized JSON properties.
67+
* Use this method to get names of JSON properties that weren't recognized during JSON
68+
* serialization by the model. This may be useful to access experimental API properties
69+
* via {@link #getUnrecognizedProperty(String)}.
70+
* When an experimental API property becomes stable,
71+
* it will eventually have static field in a model introduced
72+
* and it won't be available via this dynamic method anymore.
73+
*
74+
* See
75+
* <a href="https://docs.mapbox.com/api/navigation/directions/">Directions API documentation</a>
76+
* for available experimental fields.
77+
*
6078
* @return names of unrecognized JSON properties or an empty set
6179
*/
6280
@NonNull

0 commit comments

Comments
 (0)