com.mapbox.api.geocoding.v6

Class MapboxV6Geocoding

java.lang.Object

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

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

com.mapbox.api.geocoding.v6.MapboxV6Geocoding

public abstract class MapboxV6Geocoding
extends MapboxV6BaseGeocoding<V6Response>

This class gives you access to Mapbox forward and reverse V6 geocoding.

Forward geocoding lets you convert location text into geographic coordinates, turning 2 Lincoln Memorial Circle NW into a Point with the coordinates -77.050, 38.889.

The reverse geocoding query type allows you to look up a pair of coordinates and returns the geographic features there, including a standardized address or place and full geographic context.

See Also:

Forward Geocoding, Reverse Geocoding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxV6Geocoding.Builder This builder is used to create a new instance that holds request options for the forward 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
MapboxV6Geocoding()

Method Summary

Modifier and Type	Method and Description
static MapboxV6Geocoding.Builder	builder(java.lang.String accessToken, V6RequestOptions requestOptions) Creates a new MapboxV6Geocoding.Builder object.
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<V6Response>	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

MapboxV6Geocoding

public MapboxV6Geocoding()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

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

initializeCall

protected retrofit2.Call<V6Response> initializeCall()

Specified by:

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

builder

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

Creates a new MapboxV6Geocoding.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 or passed requestOptions have unsupported type