com.mapbox.api.directionsrefresh.v1.models

Class DirectionsRefreshResponse

java.lang.Object

com.mapbox.api.directionsrefresh.v1.models.DirectionsRefreshJsonObject

com.mapbox.api.directionsrefresh.v1.models.DirectionsRefreshResponse

All Implemented Interfaces:

java.io.Serializable

public abstract class DirectionsRefreshResponse
extends DirectionsRefreshJsonObject

Response object for Directions Refresh requests.

Since:

4.4.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DirectionsRefreshResponse()

Method Summary

Modifier and Type	Method and Description
static DirectionsRefreshResponse.Builder	builder() Create a new instance of this class by using the DirectionsRefreshResponse.Builder class.
abstract java.lang.String	code() String indicating the state of the response.
static DirectionsRefreshResponse	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	message() Optionally shows up in a response if an error or something unexpected occurred.
abstract DirectionsRouteRefresh	route() Barebones DirectionsRouteRefresh which only contains a list of RouteLegRefreshs, which only contain lists of the refreshed annotations.
static com.google.gson.TypeAdapter<DirectionsRefreshResponse>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class com.mapbox.api.directionsrefresh.v1.models.DirectionsRefreshJsonObject

toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectionsRefreshResponse

public DirectionsRefreshResponse()

Method Detail

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:

4.4.0

message

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

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

Returns:

a string containing the message

Since:

4.4.0

route

@Nullable
public abstract DirectionsRouteRefresh route()

Barebones DirectionsRouteRefresh which only contains a list of RouteLegRefreshs, which only contain lists of the refreshed annotations.

Returns:

barebones route with annotation data

Since:

4.4.0

builder

@NonNull
public static DirectionsRefreshResponse.Builder builder()

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

Returns:

this classes DirectionsRefreshResponse.Builder for creating a new instance

Since:

4.4.0

typeAdapter

public static com.google.gson.TypeAdapter<DirectionsRefreshResponse> 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:

4.4.0

fromJson

public static DirectionsRefreshResponse fromJson(java.lang.String json)

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

Parameters:

json - a formatted valid JSON string defining a Directions Refresh response

Returns:

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

Since:

4.4.0