com.mapbox.api.tilequery

Class MapboxTilequery

java.lang.Object

com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,TilequeryService>

com.mapbox.api.tilequery.MapboxTilequery

public abstract class MapboxTilequery
extends com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,TilequeryService>

The Mapbox Tilequery API allows you to retrieve data about specific features from a vector tileset, based on a given latitude and longitude.

Since:

3.5.0

See Also:

Tilequery API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxTilequery.Builder This builder is used to create a new request to the Mapbox Tilequery API.

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxTilequery()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static MapboxTilequery.Builder	builder() Build a new MapboxTilequery object with the initial value set for baseUrl().
void	cancelBatchCall() Wrapper method for Retrofit's Call.cancel() call, important to manually cancel call if the user dismisses the calling activity or no longer needs the returned results.
retrofit2.Call<java.util.List<com.mapbox.geojson.FeatureCollection>>	cloneBatchCall() Wrapper method for Retrofit's Call.clone() call, useful for getting call information.
void	enqueueBatchCall(retrofit2.Callback<java.util.List<com.mapbox.geojson.FeatureCollection>> callback) Wrapper method for Retrofit's Call.enqueue(Callback) call returning a batch response specific to the Tilequery batch API.
retrofit2.Response<java.util.List<com.mapbox.geojson.FeatureCollection>>	executeBatchCall() Wrapper method for Retrofit's Call.execute() call returning a batch response specific to the Tilequery API.
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<com.mapbox.geojson.FeatureCollection>	initializeCall()

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

MapboxTilequery

protected MapboxTilequery()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,TilequeryService>

initializeCall

protected retrofit2.Call<com.mapbox.geojson.FeatureCollection> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,TilequeryService>

executeBatchCall

public retrofit2.Response<java.util.List<com.mapbox.geojson.FeatureCollection>> executeBatchCall()
                                                                                          throws java.io.IOException

Wrapper method for Retrofit's Call.execute() call returning a batch response specific to the Tilequery API.

Returns:

the Tilequery batch response once the call completes successfully

Throws:

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

Since:

3.5.0

enqueueBatchCall

public void enqueueBatchCall(retrofit2.Callback<java.util.List<com.mapbox.geojson.FeatureCollection>> callback)

Wrapper method for Retrofit's Call.enqueue(Callback) call returning a batch response specific to the Tilequery batch API. Use this method to make a tilequery request on the Main Thread.

Parameters:

callback - a Callback which is used once the FeatureCollection is created.

Since:

3.5.0

cancelBatchCall

public void cancelBatchCall()

Wrapper method for Retrofit's Call.cancel() call, important to manually cancel call if the user dismisses the calling activity or no longer needs the returned results.

Since:

3.5.0

cloneBatchCall

public retrofit2.Call<java.util.List<com.mapbox.geojson.FeatureCollection>> cloneBatchCall()

Wrapper method for Retrofit's Call.clone() call, useful for getting call information.

Returns:

cloned call

Since:

3.5.0

builder

public static MapboxTilequery.Builder builder()

Build a new MapboxTilequery object with the initial value set for baseUrl().

Returns:

a MapboxTilequery.Builder object for creating this object

Since:

3.5.0

baseUrl

@NonNull
protected abstract java.lang.String baseUrl()

Specified by:

baseUrl in class com.mapbox.core.MapboxService<com.mapbox.geojson.FeatureCollection,TilequeryService>