com.mapbox.api.directions.v5.models

Class DirectionsResponse

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.DirectionsResponse

All Implemented Interfaces:

java.io.Serializable

public abstract class DirectionsResponse
extends DirectionsJsonObject

This is the root Mapbox Directions API response. Inside this class are several nested classes chained together to make up a similar structure to the original APIs JSON response.

Since:

1.0.0

See Also:

Direction Response Object, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectionsResponse.Builder This builder can be used to set the values describing the DirectionsResponse.

Constructor Summary

Constructors

Constructor and Description
DirectionsResponse()

Method Summary

Modifier and Type	Method and Description
static DirectionsResponse.Builder	builder() Create a new instance of this class by using the DirectionsResponse.Builder class.
abstract java.lang.String	code() String indicating the state of the response.
static DirectionsResponse	fromJson(java.io.Reader json) Deserializes a new instance of this class reading from the specified reader.
static DirectionsResponse	fromJson(java.io.Reader json, RouteOptions routeOptions) Deserializes a new instance of this class reading from the specified reader.
static DirectionsResponse	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
static DirectionsResponse	fromJson(java.lang.String json, RouteOptions routeOptions) Create a new instance of this class by passing in a formatted valid JSON String.
static DirectionsResponse	fromJson(java.lang.String json, RouteOptions routeOptions, java.lang.String requestUuid) Deprecated. use fromJson(String, RouteOptions) instead
abstract java.lang.String	message() Optionally shows up in a directions response if an error or something unexpected occurred.
abstract Metadata	metadata() A complex data structure that provides information about the source of the response.
abstract java.util.List<DirectionsRoute>	routes() List containing all the different route options.
abstract DirectionsResponse.Builder	toBuilder() Convert the current DirectionsResponse to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<DirectionsResponse>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
DirectionsResponse	updateWithRequestData(RouteOptions routeOptions) Exposes an option to enhance an existing response with the request data which might be required by downstream consumers of the directions models (like Mapbox Navigation SDK) to provide rerouting and route refreshing features.
abstract java.lang.String	uuid() A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
abstract java.util.List<DirectionsWaypoint>	waypoints() List of DirectionsWaypoint objects.

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectionsResponse

public DirectionsResponse()

Method Detail

builder

@NonNull
public static DirectionsResponse.Builder builder()

Create a new instance of this class by using the DirectionsResponse.Builder class.

Returns:

this classes DirectionsResponse.Builder for creating a new instance

Since:

3.0.0

code

@NonNull
public abstract java.lang.String code()

String indicating the state of the response. This is a separate code than the HTTP status code. On normal valid responses, the value will be Ok. The possible responses are listed below:

• Ok:200 Normal success case
• NoRoute: 200 There was no route found for the given coordinates. Check for impossible routes (e.g. routes over oceans without ferry connections).
• NoSegment: 200 No road segment could be matched for coordinates. Check for coordinates too far away from a road.
• ProfileNotFound: 404 Use a valid profile as described above
• InvalidInput: 422

Returns:

a string with one of the given values described in the list above

Since:

1.0.0

message

@Nullable
public abstract java.lang.String message()

Optionally shows up in a directions response if an error or something unexpected occurred.

Returns:

a string containing the message API Directions response with if an error occurred

Since:

3.0.0

waypoints

@Nullable
public abstract java.util.List<DirectionsWaypoint> waypoints()

List of DirectionsWaypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoint appear in the list in the order of the input coordinates.

Returns:

list of DirectionsWaypoint objects ordered from start of route till the end

Since:

1.0.0

routes

@NonNull
public abstract java.util.List<DirectionsRoute> routes()

List containing all the different route options. It's ordered by descending recommendation rank. In other words, object 0 in the List is the highest recommended route. if you don't setAlternatives to true (default is false) in your builder this should always be a List of size 1. At most this will return 2 DirectionsRoute objects.

Returns:

list of DirectionsRoute objects

Since:

1.0.0

uuid

@Nullable
public abstract java.lang.String uuid()

A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.

Returns:

a String representing the UUID given by the directions request

Since:

3.0.0

metadata

@Nullable
public abstract Metadata metadata()

A complex data structure that provides information about the source of the response.

Returns:

a Metadata with additional source information

toBuilder

public abstract DirectionsResponse.Builder toBuilder()

Convert the current DirectionsResponse to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified DirectionsResponse.

Returns:

a DirectionsResponse.Builder with the same values set to match the ones defined in this DirectionsResponse

Since:

3.0.0

typeAdapter

public static com.google.gson.TypeAdapter<DirectionsResponse> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class

Since:

3.0.0

fromJson

public static DirectionsResponse fromJson(@NonNull
                                          java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

Consider using fromJson(String, RouteOptions) if the result is used with downstream consumers of the directions models (like Mapbox Navigation SDK) to provide rerouting and route refreshing features.

Parameters:

json - a formatted valid JSON string defining a GeoJson Directions Response

Returns:

a new instance of this class defined by the values passed inside this static factory method

Since:

3.0.0

See Also:

fromJson(String, RouteOptions)

fromJson

public static DirectionsResponse fromJson(@NonNull
                                          java.io.Reader json)

Deserializes a new instance of this class reading from the specified reader.

Consider using fromJson(Reader, RouteOptions) if the result is used with downstream consumers of the directions models (like Mapbox Navigation SDK) to provide rerouting and route refreshing features.

Parameters:

json - a reader producing a valid JSON defining a GeoJson Directions Response

Returns:

a new instance of this class defined by the values passed inside this static factory method

See Also:

fromJson(Reader, RouteOptions)

fromJson

@Deprecated
public static DirectionsResponse fromJson(@NonNull
                                                      java.lang.String json,
                                                      @Nullable
                                                      RouteOptions routeOptions,
                                                      @Nullable
                                                      java.lang.String requestUuid)

Deprecated. use fromJson(String, RouteOptions) instead

Create a new instance of this class by passing in a formatted valid JSON String.

The parameters of RouteOptions that were used to make the original route request as well as the String UUID of the original response are needed by the Navigation SDK to support correct rerouting and route refreshing.

Parameters:

json - a formatted valid JSON string defining a GeoJson Directions Route

routeOptions - options that were used during the original route request

requestUuid - UUID of the request found in the body of the original response, see "response.body.uuid"

Returns:

a new instance of this class defined by the values passed inside this static factory method

See Also:

RouteOptions.fromUrl(java.net.URL), RouteOptions.fromJson(String)

fromJson

public static DirectionsResponse fromJson(@NonNull
                                          java.lang.String json,
                                          @NonNull
                                          RouteOptions routeOptions)

Create a new instance of this class by passing in a formatted valid JSON String.

The parameter of RouteOptions that were used to make the original route request which might be required by downstream consumers of the directions models (like Mapbox Navigation SDK) to provide rerouting and route refreshing features.

Parameters:

json - a formatted valid JSON string defining a GeoJson Directions Route

routeOptions - options that were used during the original route request

Returns:

a new instance of this class defined by the values passed inside this static factory method

See Also:

RouteOptions.fromUrl(java.net.URL), RouteOptions.fromJson(String)

fromJson

public static DirectionsResponse fromJson(@NonNull
                                          java.io.Reader json,
                                          @NonNull
                                          RouteOptions routeOptions)

Deserializes a new instance of this class reading from the specified reader.

The parameter of RouteOptions that were used to make the original route request which might be required by downstream consumers of the directions models (like Mapbox Navigation SDK) to provide rerouting and route refreshing features.

Parameters:

json - a reader producing a valid JSON defining a GeoJson Directions Response

routeOptions - options that were used during the original route request

Returns:

a new instance of this class defined by the values passed inside this static factory method

See Also:

RouteOptions.fromUrl(java.net.URL), RouteOptions.fromJson(String)

updateWithRequestData

@NonNull
public DirectionsResponse updateWithRequestData(@NonNull
                                                         RouteOptions routeOptions)

Exposes an option to enhance an existing response with the request data which might be required by downstream consumers of the directions models (like Mapbox Navigation SDK) to provide rerouting and route refreshing features.

Parameters:

routeOptions - options used to generate this response

See Also:

RouteOptions.fromUrl(java.net.URL), RouteOptions.fromJson(String), fromJson(String)