com.mapbox.services.api.mapmatching.v5

Class MapboxMapMatching

java.lang.Object

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

com.mapbox.services.api.mapmatching.v5.MapboxMapMatching

public class MapboxMapMatching
extends MapboxService<MapMatchingResponse>

The Mapbox map matching interface (v5)

The Mapbox Map Matching API snaps fuzzy, inaccurate traces from a GPS unit or a phone to the OpenStreetMap road and path network using the Directions API. This produces clean paths that can be displayed on a map or used for other analysis.

Since:

2.0.0

See Also:

Map matching API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxMapMatching.Builder<T extends MapboxMapMatching.Builder> Builds your map matching query by adding parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected MapboxMapMatching.Builder	builder

Constructor Summary

Constructors

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

Method Summary

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

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 MapboxMapMatching.Builder builder

Constructor Detail

MapboxMapMatching

protected MapboxMapMatching(MapboxMapMatching.Builder builder)

Method Detail

getCall

public retrofit2.Call<MapMatchingResponse> getCall()

Used internally.

Returns:

call

Since:

2.0.0

executeCall

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

Execute the call

Specified by:

executeCall in class MapboxService<MapMatchingResponse>

Returns:

The map matching v5 response

Throws:

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

Since:

2.0.0

enqueueCall

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

Execute the call

Specified by:

enqueueCall in class MapboxService<MapMatchingResponse>

Parameters:

callback - A Retrofit callback.

Since:

2.0.0

cancelCall

public void cancelCall()

Cancel the call

Specified by:

cancelCall in class MapboxService<MapMatchingResponse>

Since:

2.0.0

cloneCall

public retrofit2.Call<MapMatchingResponse> cloneCall()

clone the call

Specified by:

cloneCall in class MapboxService<MapMatchingResponse>

Returns:

cloned call

Since:

2.0.0