com.mapbox.api.geocoding.v6

Class V6ForwardGeocodingRequestOptions.Builder

java.lang.Object

com.mapbox.api.geocoding.v6.V6ForwardGeocodingRequestOptions.Builder

Enclosing class:

V6ForwardGeocodingRequestOptions

public abstract static class V6ForwardGeocodingRequestOptions.Builder
extends java.lang.Object

This builder is used to create a new instance that holds request options for the forward geocoding request.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract V6ForwardGeocodingRequestOptions.Builder	autocomplete(java.lang.Boolean autocomplete) Specify whether to return autocomplete results (true by default).
V6ForwardGeocodingRequestOptions.Builder	boundingBox(com.mapbox.geojson.BoundingBox boundingBox) Limit results to only those contained within the supplied bounding box.
abstract V6ForwardGeocodingRequestOptions	build() Build a new V6ForwardGeocodingRequestOptions object.
V6ForwardGeocodingRequestOptions.Builder	country(java.lang.String... country) Limit results to one or more country.
V6ForwardGeocodingRequestOptions.Builder	language(java.util.Locale language) Set the language of the text supplied in responses.
abstract V6ForwardGeocodingRequestOptions.Builder	language(java.lang.String language) Set the language of the text supplied in responses.
abstract V6ForwardGeocodingRequestOptions.Builder	limit(java.lang.Integer limit) Specify the maximum number of results to return.
V6ForwardGeocodingRequestOptions.Builder	proximity(com.mapbox.geojson.Point proximity) Bias the response to favor results that are closer to this location.
V6ForwardGeocodingRequestOptions.Builder	types(java.lang.String... types) Filter results to include only a subset (one or more) of the available feature types.
V6ForwardGeocodingRequestOptions.Builder	withIpAsProximity() Bias the response to favor results that are closer to the location that is retrieved by reverse IP lookup.
abstract V6ForwardGeocodingRequestOptions.Builder	worldview(java.lang.String worldview) Returns features that are defined differently by audiences that belong to various regional, cultural, or political groups.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

autocomplete

public abstract V6ForwardGeocodingRequestOptions.Builder autocomplete(@Nullable
                                                                      java.lang.Boolean autocomplete)

Specify whether to return autocomplete results (true by default). When autocomplete is enabled, results will be included that start with the requested string, rather than just responses that match it exactly. For example, a query for India might return both India and Indiana with autocomplete enabled, but only India if it's disabled.

When autocomplete is enabled, each user keystroke counts as one request to the Geocoding API. For example, a search for "Cali" would be reflected as four separate Geocoding API requests. To reduce the total requests sent, you can configure your application to only call the Geocoding API after a specific number of characters are typed.

Parameters:

autocomplete - optionally set whether to return autocomplete results

Returns:

this builder for chaining options together

boundingBox

public V6ForwardGeocodingRequestOptions.Builder boundingBox(@NonNull
                                                            com.mapbox.geojson.BoundingBox boundingBox)

Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian.

Parameters:

boundingBox - the bounding box

Returns:

this builder for chaining options together

country

public V6ForwardGeocodingRequestOptions.Builder country(@NonNull
                                                        java.lang.String... country)

Limit results to one or more country. Each country can be represented as: - ISO 3166 alpha 2 country codes - Generally recognized country name - In some cases like Hong Kong, an area of quasi-national administrative status that has been given a designated country code under ISO 3166-1.

Parameters:

country - limit geocoding results to one or more country

Returns:

this builder for chaining options together

language

public V6ForwardGeocodingRequestOptions.Builder language(java.util.Locale language)

Set the language of the text supplied in responses. Also affects result scoring, with results matching the user's query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich ("France") with a German (de) language parameter.

Options are IETF language tags comprised of a mandatory ISO 639-1 language code and, optionally, one or more IETF subtags for country or script.

Parameters:

language - language of the text supplied in responses

Returns:

this builder for chaining options together

language

public abstract V6ForwardGeocodingRequestOptions.Builder language(java.lang.String language)

Set the language of the text supplied in responses. Also affects result scoring, with results matching the user's query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich ("France") with a German (de) language parameter.

Options are IETF language tags comprised of a mandatory ISO 639-1 language code and, optionally, one or more IETF subtags for country or script.

Parameters:

language - language of the text supplied in responses

Returns:

this builder for chaining options together

limit

public abstract V6ForwardGeocodingRequestOptions.Builder limit(java.lang.Integer limit)

Specify the maximum number of results to return. The default is 5 and the maximum supported is 10.

Parameters:

limit - the number of returned results

Returns:

this builder for chaining options together

withIpAsProximity

public V6ForwardGeocodingRequestOptions.Builder withIpAsProximity()

Bias the response to favor results that are closer to the location that is retrieved by reverse IP lookup.

Returns:

this builder for chaining options together

proximity

public V6ForwardGeocodingRequestOptions.Builder proximity(@NonNull
                                                          com.mapbox.geojson.Point proximity)

Bias the response to favor results that are closer to this location.

Parameters:

proximity - a point to bias the response

Returns:

this builder for chaining options together

types

public V6ForwardGeocodingRequestOptions.Builder types(@NonNull
                                                      java.lang.String... types)

Filter results to include only a subset (one or more) of the available feature types. Only values defined in V6FeatureType.FeatureType are allowed.

Parameters:

types - filter results to include only a subset of the available feature types

Returns:

this builder for chaining options together

See Also:

Geographic Feature Types

worldview

public abstract V6ForwardGeocodingRequestOptions.Builder worldview(@NonNull
                                                                   java.lang.String worldview)

Returns features that are defined differently by audiences that belong to various regional, cultural, or political groups.

Available worldviews are defined in V6Worldview. If worldview is not set, the us worldview boundaries are returned by default.

Parameters:

worldview - worldview code

Returns:

this builder for chaining options together

See Also:

Worldviews

build

public abstract V6ForwardGeocodingRequestOptions build()

Build a new V6ForwardGeocodingRequestOptions object.

Returns:

a new V6ForwardGeocodingRequestOptions