MapboxGeocoding.Builder (libjava-services 2.2.2 API)

java.lang.Object
- com.mapbox.services.api.MapboxBuilder
- - com.mapbox.services.api.geocoding.v5.MapboxGeocoding.Builder<T>

Enclosing class:: MapboxGeocoding

public static class MapboxGeocoding.Builder<T extends MapboxGeocoding.Builder>
extends MapboxBuilder

Builds your geocoder query by adding parameters.

Since:: 1.0.0

Field Summary
- Fields inherited from class com.mapbox.services.api.MapboxBuilder
  baseUrl, clientAppName

Constructor Summary

Constructors
Constructor and Description

Builder()
Constructor

Constructors
Constructor and Description
`Builder()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MapboxGeocoding`	`build()` Build method
`java.lang.String`	`getAccessToken()`
`java.lang.Boolean`	`getAutocomplete()`
`java.lang.String`	`getBbox()`
`java.lang.String`	`getCountry()`
`java.lang.String`	`getGeocodingTypes()` If you filtered your results by one or more types you can get what those filters are by using this method.
`java.lang.String`	`getLanguages()`
`java.lang.String`	`getLimit()`
`java.lang.String`	`getMode()`
`java.lang.String`	`getProximity()` Location around which you biased the results.
`java.lang.String`	`getQuery()`
`T`	`setAccessToken(java.lang.String accessToken)` Required to call when building `MapboxGeocoding.Builder`
`T`	`setAutocomplete(boolean autocomplete)` Whether or not to return autocomplete results.
`T`	`setBaseUrl(java.lang.String baseUrl)` Set the base url of the API.
`T`	`setBbox(double minX, double minY, double maxX, double maxY)` Bounding box within which to limit results.
`T`	`setBbox(com.mapbox.services.commons.models.Position northeast, com.mapbox.services.commons.models.Position southwest)` Bounding box within which to limit results.
`T`	`setClientAppName(java.lang.String appName)` Set the App Name to identify
`T`	`setCoordinates(com.mapbox.services.commons.models.Position position)`
`T`	`setCountries(java.lang.String[] countries)` Countries which you want the results to show up in.
`T`	`setCountry(java.lang.String country)` Country which you want the results to show up in.
`T`	`setGeocodingType(java.lang.String geocodingType)` Filter results by one or more type.
`T`	`setGeocodingTypes(java.lang.String[] geocodingType)` Filter results by one or more type.
`T`	`setLanguage(java.lang.String language)` Deprecated. use `setLanguages(String...)` instead which allows for multiple languages
`T`	`setLanguages(java.lang.String... language)` The locale in which results should be returned.
`T`	`setLimit(int limit)` Limit the number of results returned.
`T`	`setLocation(java.lang.String location)` The location equals the query.
`T`	`setMode(java.lang.String mode)` mapbox.places or mapbox.places-permanent for enterprise/batch geocoding.
`T`	`setProximity(com.mapbox.services.commons.models.Position position)` Location around which to bias results.

Methods inherited from class com.mapbox.services.api.MapboxBuilder
getBaseUrl, getClientAppName, validateAccessToken

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructor
    
    Since:
    
    1.0.0
- Method Detail
  - setAccessToken
```
public T setAccessToken(java.lang.String accessToken)
```
    Required to call when building MapboxGeocoding.Builder
    
    Specified by:
    
    setAccessToken in class MapboxBuilder
    
    Parameters:
    
    accessToken - Mapbox access token, you must have a Mapbox account in order to use this library.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setLocation
```
public T setLocation(java.lang.String location)
```
    The location equals the query.
    
    Parameters:
    
    location - query
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setCoordinates
```
public T setCoordinates(com.mapbox.services.commons.models.Position position)
```
    Parameters:
    
    position - Position
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setMode
```
public T setMode(java.lang.String mode)
```
    mapbox.places or mapbox.places-permanent for enterprise/batch geocoding.
    
    Parameters:
    
    mode - mapbox.places or mapbox.places-permanent for enterprise/batch geocoding.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setCountry
```
public T setCountry(java.lang.String country)
```
    Country which you want the results to show up in.
    
    Parameters:
    
    country - ISO 3166 alpha 2 country code
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setCountries
```
public T setCountries(java.lang.String[] countries)
```
    Countries which you want the results to show up in.
    
    Parameters:
    
    countries - ISO 3166 alpha 2 country codes, separated by commas.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setProximity
```
public T setProximity(com.mapbox.services.commons.models.Position position)
```
    Location around which to bias results.
    
    Parameters:
    
    position - A Position.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setGeocodingType
```
public T setGeocodingType(java.lang.String geocodingType)
```
    Filter results by one or more type. Options are country, region, postcode, place, locality, neighborhood, address, poi, poi.landmark. Multiple options can be comma-separated.
    
    Parameters:
    
    geocodingType - String filtering the geocoder result types.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setGeocodingTypes
```
public T setGeocodingTypes(java.lang.String[] geocodingType)
```
    Filter results by one or more type. Options are country, region, postcode, place, locality, neighborhood, address, poi, poi.landmark. Multiple options can be comma-separated.
    
    Parameters:
    
    geocodingType - String array filtering the geocoder result types.
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setAutocomplete
```
public T setAutocomplete(boolean autocomplete)
```
    Whether or not to return autocomplete results.
    
    Parameters:
    
    autocomplete - true, if you want autocomplete results, else false. (Defaults true)
    
    Returns:
    
    Builder
    
    Since:
    
    1.0.0
  - setBbox
```
public T setBbox(com.mapbox.services.commons.models.Position northeast,
                 com.mapbox.services.commons.models.Position southwest)
          throws ServicesException
```
    Bounding box within which to limit results.
    
    Parameters:
    
    northeast - The northeast corner of the bounding box as Position.
    
    southwest - The southwest corner of the bounding box as Position.
    
    Returns:
    
    Builder
    
    Throws:
    
    ServicesException - Generic Exception for all things geocoding.
    
    Since:
    
    1.0.0
  - setBbox
```
public T setBbox(double minX,
                 double minY,
                 double maxX,
                 double maxY)
          throws ServicesException
```
    Bounding box within which to limit results.
    
    Parameters:
    
    minX - The minX of bounding box when maps facing north.
    
    minY - The minY of bounding box when maps facing north.
    
    maxX - The maxX of bounding box when maps facing north.
    
    maxY - The maxY of bounding box when maps facing north.
    
    Returns:
    
    Builder
    
    Throws:
    
    ServicesException - Generic Exception for all things geocoding.
    
    Since:
    
    1.0.0
  - setLimit
```
public T setLimit(int limit)
```
    Limit the number of results returned. The default is 5 for forward geocoding and 1 for reverse geocoding.
    
    Parameters:
    
    limit - the integer value representing the amount of results desired.
    
    Returns:
    
    Builder
    
    Since:
    
    2.0.0
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    Specified by:
    
    getAccessToken in class MapboxBuilder
    
    Returns:
    
    your Mapbox access token.
    
    Since:
    
    1.0.0
  - getQuery
```
public java.lang.String getQuery()
```
    Returns:
    
    your geocoder query.
    
    Since:
    
    1.0.0
  - getMode
```
public java.lang.String getMode()
```
    Returns:
    
    mapbox.places or mapbox.places-permanent for enterprise/batch geocoding.
    
    Since:
    
    1.0.0
  - getCountry
```
public java.lang.String getCountry()
```
    Returns:
    
    ISO 3166 alpha 2 country codes, separated by commas
    
    Since:
    
    1.0.0
  - getProximity
```
public java.lang.String getProximity()
```
    Location around which you biased the results.
    
    Returns:
    
    String with the format longitude, latitude.
    
    Since:
    
    1.0.0
  - getGeocodingTypes
```
public java.lang.String getGeocodingTypes()
```
    If you filtered your results by one or more types you can get what those filters are by using this method.
    
    Returns:
    
    String with list of filters you used.
    
    Since:
    
    1.0.0
  - getAutocomplete
```
public java.lang.Boolean getAutocomplete()
```
    Returns:
    
    true if autocomplete results, else false.
    
    Since:
    
    1.0.0
  - getBbox
```
public java.lang.String getBbox()
```
    Returns:
    
    Bounding box within which the results are limited
    
    Since:
    
    1.0.0
  - getLimit
```
public java.lang.String getLimit()
```
    Returns:
    
    the integer value representing the amount of results desired.
    
    Since:
    
    2.0.0
  - getLanguages
```
public java.lang.String getLanguages()
```
    Returns:
    
    The locale in which results should be returned.
    
    Since:
    
    2.0.0
  - setLanguage
```
@Deprecated
public T setLanguage(java.lang.String language)
```
    Deprecated. use setLanguages(String...) instead which allows for multiple languages
    
    The locale in which results should be returned.
    This property affects the languages of returned results; generally speaking, it does not determine which results are found. If the Geocoding API does not recognize the languages code, it may fall back to another languages or the default languages. Components other than the languages code, such as the country and script codes, are ignored.
    By default, this property is set to `null`, causing results to be in the default languages.
    This option is experimental.
    
    Parameters:
    
    language - The locale in which results should be returned.
    
    Returns:
    
    the current MapboxBuilder instance
    
    Since:
    
    2.0.0
  - setLanguages
```
public T setLanguages(java.lang.String... language)
```
    The locale in which results should be returned.
    This property affects the languages of returned results; generally speaking, it does not determine which results are found. If the Geocoding API does not recognize the languages code, it may fall back to another languages or the default languages. Components other than the languages code, such as the country and script codes, are ignored. This API allows for multiple values.
    By default, this property is set to `null`, causing results to be in the default languages.
    This option is experimental.
    
    Parameters:
    
    language - The locale in which results should be returned.
    
    Returns:
    
    the current MapboxBuilder instance
    
    Since:
    
    2.2.0
  - setClientAppName
```
public T setClientAppName(java.lang.String appName)
```
    Description copied from class: MapboxBuilder
    
    Set the App Name to identify
    
    Specified by:
    
    setClientAppName in class MapboxBuilder
    
    Parameters:
    
    appName - base package name or other simple string identifier
    
    Returns:
    
    the current MapboxBuilder instance
  - setBaseUrl
```
public T setBaseUrl(java.lang.String baseUrl)
```
    Set the base url of the API.
    
    Specified by:
    
    setBaseUrl in class MapboxBuilder
    
    Parameters:
    
    baseUrl - base url used as end point
    
    Returns:
    
    the current MapboxBuilder instance
    
    Since:
    
    2.0.0
  - build
```
public MapboxGeocoding build()
                      throws ServicesException
```
    Build method
    
    Specified by:
    
    build in class MapboxBuilder
    
    Returns:
    
    MapboxGeocoding
    
    Throws:
    
    ServicesException - Generic Exception for all things geocoding.
    
    Since:
    
    1.0.0

Class MapboxGeocoding.Builder<T extends MapboxGeocoding.Builder>

Field Summary

Fields inherited from class com.mapbox.services.api.MapboxBuilder

Constructor Summary

Method Summary

Methods inherited from class com.mapbox.services.api.MapboxBuilder

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setAccessToken

setLocation

setCoordinates

setMode

setCountry

setCountries

setProximity

setGeocodingType

setGeocodingTypes

setAutocomplete

setBbox

setBbox

setLimit

getAccessToken

getQuery

getMode

getCountry

getProximity

getGeocodingTypes

getAutocomplete

getBbox

getLimit

getLanguages

setLanguage

setLanguages

setClientAppName

setBaseUrl

build