com.mapbox.api.geocoding.v6

Class V6StructuredInputQuery.Builder

java.lang.Object

com.mapbox.api.geocoding.v6.V6StructuredInputQuery.Builder

Enclosing class:

V6StructuredInputQuery

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

This builder is used to create a new instance that holds structured input request options.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract V6StructuredInputQuery.Builder	addressLine1(java.lang.String addressLine1) A string including address_number and street.
abstract V6StructuredInputQuery.Builder	addressNumber(java.lang.String addressNumber) The number associated with the house.
abstract V6StructuredInputQuery.Builder	block(java.lang.String block) In some countries like Japan, the block is a component in the address.
V6StructuredInputQuery	build() Build a new V6StructuredInputQuery object.
abstract V6StructuredInputQuery.Builder	country(java.lang.String country) Generally recognized countries or, in some cases like Hong Kong, an area of quasi-national administrative status that has a designated country code under ISO 3166-1.
abstract V6StructuredInputQuery.Builder	locality(java.lang.String locality) Official sub-city features present in countries where such an additional administrative layer is used in postal addressing, or where such features are commonly referred to in local parlance.
abstract V6StructuredInputQuery.Builder	neighborhood(java.lang.String neighborhood) Colloquial sub-city features often referred to in local parlance.
abstract V6StructuredInputQuery.Builder	place(java.lang.String place) Typically these are cities, villages, municipalities, etc.
abstract V6StructuredInputQuery.Builder	postcode(java.lang.String postcode) Postal codes used in country-specific national addressing systems.
abstract V6StructuredInputQuery.Builder	region(java.lang.String region) Top-level sub-national administrative features, such as states in the United States or provinces in Canada or China.
abstract V6StructuredInputQuery.Builder	street(java.lang.String street) The name of the street in the address.

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

addressLine1

public abstract V6StructuredInputQuery.Builder addressLine1(@NonNull
                                                            java.lang.String addressLine1)

A string including address_number and street. These values can be provided as separate parameters address_number and street listed below.

Parameters:

addressLine1 - structured input component.

Returns:

this builder for chaining options together

addressNumber

public abstract V6StructuredInputQuery.Builder addressNumber(@NonNull
                                                             java.lang.String addressNumber)

The number associated with the house.

Parameters:

addressNumber - structured input component.

Returns:

this builder for chaining options together

street

public abstract V6StructuredInputQuery.Builder street(@NonNull
                                                      java.lang.String street)

The name of the street in the address.

Parameters:

street - structured input component.

Returns:

this builder for chaining options together

block

public abstract V6StructuredInputQuery.Builder block(@NonNull
                                                     java.lang.String block)

In some countries like Japan, the block is a component in the address.

Parameters:

block - structured input component.

Returns:

this builder for chaining options together

place

public abstract V6StructuredInputQuery.Builder place(@NonNull
                                                     java.lang.String place)

Typically these are cities, villages, municipalities, etc. They are usually features used in postal addressing, and are suitable for display in ambient end-user applications where current-location context is needed (for example, in weather displays).

Parameters:

place - structured input component.

Returns:

this builder for chaining options together

region

public abstract V6StructuredInputQuery.Builder region(@NonNull
                                                      java.lang.String region)

Top-level sub-national administrative features, such as states in the United States or provinces in Canada or China.

Parameters:

region - structured input component.

Returns:

this builder for chaining options together

postcode

public abstract V6StructuredInputQuery.Builder postcode(@NonNull
                                                        java.lang.String postcode)

Postal codes used in country-specific national addressing systems.

Parameters:

postcode - structured input component.

Returns:

this builder for chaining options together

locality

public abstract V6StructuredInputQuery.Builder locality(@NonNull
                                                        java.lang.String locality)

Official sub-city features present in countries where such an additional administrative layer is used in postal addressing, or where such features are commonly referred to in local parlance. Examples include city districts in Brazil and Chile and arrondissements in France.

Parameters:

locality - structured input component.

Returns:

this builder for chaining options together

neighborhood

public abstract V6StructuredInputQuery.Builder neighborhood(@NonNull
                                                            java.lang.String neighborhood)

Colloquial sub-city features often referred to in local parlance. Unlike locality features, these typically lack official status and may lack universally agreed-upon boundaries.

Parameters:

neighborhood - structured input component.

Returns:

this builder for chaining options together

country

public abstract V6StructuredInputQuery.Builder country(@NonNull
                                                       java.lang.String country)

Generally recognized countries or, in some cases like Hong Kong, an area of quasi-national administrative status that has a designated country code under ISO 3166-1.

Parameters:

country - structured input component.

Returns:

this builder for chaining options together

build

public V6StructuredInputQuery build()

Build a new V6StructuredInputQuery object.

Returns:

a new V6StructuredInputQuery using the provided values in this builder

Throws:

com.mapbox.core.exceptions.ServicesException - if all components are null.