com.mapbox.api.geocoding.v6

Class V6ForwardGeocodingRequestOptions

java.lang.Object

com.mapbox.api.geocoding.v6.V6ForwardGeocodingRequestOptions

All Implemented Interfaces:

V6RequestOptions

public abstract class V6ForwardGeocodingRequestOptions
extends java.lang.Object
implements V6RequestOptions

Request parameters used to refine the results of a V6 forward geocoding query.

See Also:

Forward geocoding

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
V6ForwardGeocodingRequestOptions()

Method Summary

Modifier and Type	Method and Description
static V6ForwardGeocodingRequestOptions.Builder	builder(java.lang.String query) Creates a new V6ForwardGeocodingRequestOptions.Builder object with query parameter.
static V6ForwardGeocodingRequestOptions.Builder	builder(V6StructuredInputQuery query) Creates a new V6ForwardGeocodingRequestOptions.Builder object with structured input query parameter.
static com.google.gson.TypeAdapter<V6ForwardGeocodingRequestOptions>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

V6ForwardGeocodingRequestOptions

public V6ForwardGeocodingRequestOptions()

Method Detail

builder

public static V6ForwardGeocodingRequestOptions.Builder builder(@NonNull
                                                               java.lang.String query)

Creates a new V6ForwardGeocodingRequestOptions.Builder object with query parameter.

Parameters:

query - The feature you're trying to look up. This could be an address, a city name, etc.

Returns:

Builder object.

Throws:

com.mapbox.core.exceptions.ServicesException - if query is empty

builder

public static V6ForwardGeocodingRequestOptions.Builder builder(@NonNull
                                                               V6StructuredInputQuery query)

Creates a new V6ForwardGeocodingRequestOptions.Builder object with structured input query parameter.

Parameters:

query - structured input query.

Returns:

Builder object.

typeAdapter

public static com.google.gson.TypeAdapter<V6ForwardGeocodingRequestOptions> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class