com.mapbox.services.api.geocoding.v5

Class MapboxGeocoding

java.lang.Object

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

com.mapbox.services.api.geocoding.v5.MapboxGeocoding

public class MapboxGeocoding
extends MapboxService<GeocodingResponse>

The Mapbox geocoding client (v5).

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxGeocoding.Builder<T extends MapboxGeocoding.Builder> Builds your geocoder query by adding parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected MapboxGeocoding.Builder	builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxGeocoding(MapboxGeocoding.Builder builder) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelBatchCall() Cancel the batch call
void	cancelCall() Cancel the call
retrofit2.Call<java.util.List<GeocodingResponse>>	cloneBatchCall() clone the batch call
retrofit2.Call<GeocodingResponse>	cloneCall() clone the call
void	enqueueBatchCall(retrofit2.Callback<java.util.List<GeocodingResponse>> callback) Execute the batch call
void	enqueueCall(retrofit2.Callback<GeocodingResponse> callback) Execute the call
retrofit2.Response<java.util.List<GeocodingResponse>>	executeBatchCall() Execute the batch call
retrofit2.Response<GeocodingResponse>	executeCall() Execute the call
retrofit2.Call<java.util.List<GeocodingResponse>>	getBatchCall() Used internally.
retrofit2.Call<GeocodingResponse>	getCall() Used internally.
protected com.google.gson.Gson	getGson()
GeocodingService	getService() 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 MapboxGeocoding.Builder builder

Constructor Detail

MapboxGeocoding

protected MapboxGeocoding(MapboxGeocoding.Builder builder)

Public constructor.

Parameters:

builder - MapboxGeocoding.Builder object.

Since:

1.0.0

Method Detail

getGson

protected com.google.gson.Gson getGson()

getService

public GeocodingService getService()

Used internally.

Returns:

Geocoding service.

Since:

1.0.0

getCall

public retrofit2.Call<GeocodingResponse> getCall()

Used internally.

Returns:

call

Since:

1.0.0

getBatchCall

public retrofit2.Call<java.util.List<GeocodingResponse>> getBatchCall()

Used internally.

Returns:

batch call

Since:

2.0.0

executeCall

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

Execute the call

Specified by:

executeCall in class MapboxService<GeocodingResponse>

Returns:

The Geocoding v5 response

Throws:

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

Since:

1.0.0

executeBatchCall

public retrofit2.Response<java.util.List<GeocodingResponse>> executeBatchCall()
                                                                       throws java.io.IOException

Execute the batch call

Returns:

The Geocoding 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<GeocodingResponse> callback)

Execute the call

Specified by:

enqueueCall in class MapboxService<GeocodingResponse>

Parameters:

callback - A Retrofit callback.

Since:

1.0.0

enqueueBatchCall

public void enqueueBatchCall(retrofit2.Callback<java.util.List<GeocodingResponse>> callback)

Execute the batch call

Parameters:

callback - A Retrofit callback.

Since:

2.0.0

cancelCall

public void cancelCall()

Cancel the call

Specified by:

cancelCall in class MapboxService<GeocodingResponse>

Since:

1.0.0

cancelBatchCall

public void cancelBatchCall()

Cancel the batch call

Since:

2.0.0

cloneCall

public retrofit2.Call<GeocodingResponse> cloneCall()

clone the call

Specified by:

cloneCall in class MapboxService<GeocodingResponse>

Returns:

cloned call

Since:

1.0.0

cloneBatchCall

public retrofit2.Call<java.util.List<GeocodingResponse>> cloneBatchCall()

clone the batch call

Returns:

cloned call

Since:

2.0.0