com.mapbox.services.api.directionsmatrix.v1

Class MapboxDirectionsMatrix

java.lang.Object

com.mapbox.services.api.MapboxService<DirectionsMatrixResponse>

com.mapbox.services.api.directionsmatrix.v1.MapboxDirectionsMatrix

public class MapboxDirectionsMatrix
extends MapboxService<DirectionsMatrixResponse>

The Directions Matrix API returns all travel times between many points. The Matrix API will always return the duration on the fastest route. Durations between points may not be symmetric (for example A to B may have a different duration than B to A), as the routes may differ by direction due to one-way streets or turn restrictions. The Matrix API returns durations in seconds. It does not return route geometries or distances.

This API allows you to build tools that efficiently check the reachability of coordinates from each other, filter points by travel time, or run your own algorithms for solving optimization problems.

The standard limit for request are a maximum 60 requests per minute and maximum 25 input coordinates. For example you can request a symmetric 25x25 matrix, an asymmetric 1x24 matrix with distinct coordinates or a 12x24 where sources and destinations share some coordinates. For higher volumes contact us.

This replace the distance.v1 API

Since:

2.1.0

See Also:

API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxDirectionsMatrix.Builder<T extends MapboxDirectionsMatrix.Builder> Directions Matrix v1 builder

Field Summary

Fields

Modifier and Type	Field and Description
protected MapboxDirectionsMatrix.Builder	builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxDirectionsMatrix(MapboxDirectionsMatrix.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	cancelCall() Cancel the call
retrofit2.Call<DirectionsMatrixResponse>	cloneCall() clone the call
void	enqueueCall(retrofit2.Callback<DirectionsMatrixResponse> callback) Execute the call
retrofit2.Response<DirectionsMatrixResponse>	executeCall() Execute the call

Methods inherited from class com.mapbox.services.api.MapboxService

getCallFactory, getHeaderUserAgent, getOkHttpClient, isEnableDebug, setCallFactory, setEnableDebug

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected MapboxDirectionsMatrix.Builder builder

Constructor Detail

MapboxDirectionsMatrix

protected MapboxDirectionsMatrix(MapboxDirectionsMatrix.Builder builder)

Method Detail

executeCall

public retrofit2.Response<DirectionsMatrixResponse> executeCall()
                                                         throws java.io.IOException

Execute the call

Specified by:

executeCall in class MapboxService<DirectionsMatrixResponse>

Returns:

The Directions Matrix v1 response

Throws:

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

Since:

2.1.0

enqueueCall

public void enqueueCall(retrofit2.Callback<DirectionsMatrixResponse> callback)

Execute the call

Specified by:

enqueueCall in class MapboxService<DirectionsMatrixResponse>

Parameters:

callback - A Retrofit callback.

Since:

2.1.0

cancelCall

public void cancelCall()

Cancel the call

Specified by:

cancelCall in class MapboxService<DirectionsMatrixResponse>

Since:

2.1.0

cloneCall

public retrofit2.Call<DirectionsMatrixResponse> cloneCall()

clone the call

Specified by:

cloneCall in class MapboxService<DirectionsMatrixResponse>

Returns:

cloned call

Since:

2.1.0