com.mapbox.api.geocoding.v6

Class MapboxV6BatchGeocoding

java.lang.Object

com.mapbox.core.MapboxService<T,com.mapbox.api.geocoding.v6.V6GeocodingService>

com.mapbox.api.geocoding.v6.MapboxV6BaseGeocoding<V6BatchResponse>

com.mapbox.api.geocoding.v6.MapboxV6BatchGeocoding

public abstract class MapboxV6BatchGeocoding
extends MapboxV6BaseGeocoding<V6BatchResponse>

This class gives you access to Mapbox V6 batch geocoding. The batch geocoding query type allows you to request up to 1000 forward or reverse geocoding queries in a single request.

See Also:

Batch Geocoding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxV6BatchGeocoding.Builder This builder is used to create a new instance that holds request options for the batch geocoding request.

Nested classes/interfaces inherited from class com.mapbox.api.geocoding.v6.MapboxV6BaseGeocoding

MapboxV6BaseGeocoding.BaseBuilder<T>

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Constructor and Description
MapboxV6BatchGeocoding()

Method Summary

Modifier and Type	Method and Description
static MapboxV6BatchGeocoding.Builder	builder(java.lang.String accessToken, java.util.List<? extends V6RequestOptions> requestOptions) Creates a new MapboxV6BatchGeocoding.Builder object.
static MapboxV6BatchGeocoding.Builder	builder(java.lang.String accessToken, V6RequestOptions... requestOptions) Creates a new MapboxV6BatchGeocoding.Builder object.
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<V6BatchResponse>	initializeCall()

Methods inherited from class com.mapbox.api.geocoding.v6.MapboxV6BaseGeocoding

accessToken, baseUrl, clientAppName, permanent

Methods inherited from class com.mapbox.core.MapboxService

cancelCall, cloneCall, enableDebug, enqueueCall, executeCall, getCall, getCallFactory, getOkHttpClient, getRetrofit, getService, isEnableDebug, setCallFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MapboxV6BatchGeocoding

public MapboxV6BatchGeocoding()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<V6BatchResponse,com.mapbox.api.geocoding.v6.V6GeocodingService>

initializeCall

protected retrofit2.Call<V6BatchResponse> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<V6BatchResponse,com.mapbox.api.geocoding.v6.V6GeocodingService>

builder

public static MapboxV6BatchGeocoding.Builder builder(@NonNull
                                                     java.lang.String accessToken,
                                                     @NonNull
                                                     V6RequestOptions... requestOptions)

Creates a new MapboxV6BatchGeocoding.Builder object.

Parameters:

accessToken - a valid Mapbox Access Token used for API request

requestOptions - options specified for this geocoding request

Returns:

Builder object.

Throws:

com.mapbox.core.exceptions.ServicesException - if accessToken is in incorrect format

builder

public static MapboxV6BatchGeocoding.Builder builder(@NonNull
                                                     java.lang.String accessToken,
                                                     @NonNull
                                                     java.util.List<? extends V6RequestOptions> requestOptions)

Creates a new MapboxV6BatchGeocoding.Builder object.

Parameters:

accessToken - a valid Mapbox Access Token used for API request

requestOptions - options specified for this geocoding request

Returns:

Builder object.

Throws:

com.mapbox.core.exceptions.ServicesException - if accessToken is in incorrect format