com.mapbox.api.directions.v5

Class MapboxDirections

java.lang.Object

com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

com.mapbox.api.directions.v5.MapboxDirections

public abstract class MapboxDirections
extends com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

The Directions API allows the calculation of routes between coordinates. The fastest route can be returned with geometries, turn-by-turn instructions, and much more. The Mapbox Directions API supports routing for driving cars (including live traffic), riding bicycles and walking.

Requested routes can include as much as 25 coordinates anywhere on earth (except the traffic profile which support up to 3 coordinates, contact Mapbox Support if you'd like to extend this limit).

Requesting a route at a bare minimal must include, a Mapbox access token, destination, and an origin.

See Also:

Android Directions documentation, Directions API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxDirections.Builder Builder class used to create a new instance of MapboxDirections.

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxDirections()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	baseUrl()
static MapboxDirections.Builder	builder() Build a new MapboxDirections object.
void	enqueueCall(retrofit2.Callback<com.mapbox.api.directions.v5.models.DirectionsResponse> callback) Wrapper method for Retrofits Call.enqueue(Callback) call returning a response specific to the Directions API.
retrofit2.Response<com.mapbox.api.directions.v5.models.DirectionsResponse>	executeCall() Wrapper method for Retrofits Call.execute() call returning a response specific to the Directions API synchronously.
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected okhttp3.OkHttpClient	getOkHttpClient()
protected retrofit2.Call<com.mapbox.api.directions.v5.models.DirectionsResponse>	initializeCall()
abstract MapboxDirections.Builder	toBuilder() Returns the builder which created this instance of MapboxDirections and allows for modification and building a new directions request with new information.

Methods inherited from class com.mapbox.core.MapboxService

cancelCall, cloneCall, enableDebug, getCall, getCallFactory, getRetrofit, getService, isEnableDebug, setCallFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MapboxDirections

protected MapboxDirections()

Method Detail

baseUrl

protected java.lang.String baseUrl()

Specified by:

baseUrl in class com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

initializeCall

protected retrofit2.Call<com.mapbox.api.directions.v5.models.DirectionsResponse> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

executeCall

public retrofit2.Response<com.mapbox.api.directions.v5.models.DirectionsResponse> executeCall()
                                                                                       throws java.io.IOException

Wrapper method for Retrofits Call.execute() call returning a response specific to the Directions API synchronously.

Overrides:

executeCall in class com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

Returns:

the Directions v5 response once the call completes successfully

Throws:

java.io.IOException - Signals that an I/O exception of some sort has occurred

enqueueCall

public void enqueueCall(retrofit2.Callback<com.mapbox.api.directions.v5.models.DirectionsResponse> callback)

Wrapper method for Retrofits Call.enqueue(Callback) call returning a response specific to the Directions API.

Overrides:

enqueueCall in class com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

Parameters:

callback - a Callback which is used once the DirectionsResponse is created.

Since:

1.0.0

getOkHttpClient

protected okhttp3.OkHttpClient getOkHttpClient()

Overrides:

getOkHttpClient in class com.mapbox.core.MapboxService<com.mapbox.api.directions.v5.models.DirectionsResponse,com.mapbox.api.directions.v5.DirectionsService>

builder

public static MapboxDirections.Builder builder()

Build a new MapboxDirections object.

Returns:

a MapboxDirections.Builder object for creating this object

toBuilder

public abstract MapboxDirections.Builder toBuilder()

Returns the builder which created this instance of MapboxDirections and allows for modification and building a new directions request with new information.

Returns:

MapboxDirections.Builder with the same variables set as this directions object

Since:

3.0.0