com.mapbox.api.geocoding.v6

Class V6ReverseGeocodingRequestOptions.Builder

java.lang.Object

com.mapbox.api.geocoding.v6.V6ReverseGeocodingRequestOptions.Builder

Enclosing class:

V6ReverseGeocodingRequestOptions

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract V6ReverseGeocodingRequestOptions	build() Build a new V6ReverseGeocodingRequestOptions object.
V6ReverseGeocodingRequestOptions.Builder	country(java.lang.String... country) Limit results to one or more country.
V6ReverseGeocodingRequestOptions.Builder	language(java.util.Locale language) Set the language of the text supplied in responses.
abstract V6ReverseGeocodingRequestOptions.Builder	language(java.lang.String language) Set the language of the text supplied in responses.
abstract V6ReverseGeocodingRequestOptions.Builder	limit(java.lang.Integer limit) Specify the maximum number of results to return.
V6ReverseGeocodingRequestOptions.Builder	types(java.lang.String... types) Filter results to include only a subset (one or more) of the available feature types.
abstract V6ReverseGeocodingRequestOptions.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

country

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

Limit results to one or more country. Permitted values are ISO 3166 alpha 2 country codes.

Parameters:

country - limit geocoding results to one or more country

Returns:

this builder for chaining options together

language

public V6ReverseGeocodingRequestOptions.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 V6ReverseGeocodingRequestOptions.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 V6ReverseGeocodingRequestOptions.Builder limit(java.lang.Integer limit)

Specify the maximum number of results to return. The default is 1 and the maximum supported is 5. The default behavior in reverse geocoding is to return at most one feature at each of the multiple levels of the administrative hierarchy (for example, one address, one region, one country). Increasing the limit allows returning multiple features of the same type, but only for one type (for example, multiple address results). Consequently, setting limit to a higher-than-default value requires specifying exactly one types parameter.

Parameters:

limit - the number of returned results

Returns:

this builder for chaining options together

types

public V6ReverseGeocodingRequestOptions.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 V6ReverseGeocodingRequestOptions.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 V6ReverseGeocodingRequestOptions build()

Build a new V6ReverseGeocodingRequestOptions object.

Returns:

a new V6ReverseGeocodingRequestOptions