com.mapbox.services.api.mapmatching.v5

Class MapboxMapMatching.Builder<T extends MapboxMapMatching.Builder>

java.lang.Object

com.mapbox.services.api.MapboxBuilder

com.mapbox.services.api.mapmatching.v5.MapboxMapMatching.Builder<T>

Enclosing class:

MapboxMapMatching

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

Builds your map matching query by adding parameters.

Since:

2.0.0

Field Summary

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

baseUrl, clientAppName

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor

Method Summary

Modifier and Type	Method and Description
MapboxMapMatching	build() Builder method
java.lang.String	getAccessToken()
java.lang.String	getAnnotations()
java.lang.String	getCoordinates()
java.lang.String	getGeometries()
java.lang.String	getLanguage()
java.lang.String	getOverview()
java.lang.String	getProfile()
java.lang.String	getRadiuses()
java.lang.Boolean	getSteps()
java.lang.String	getTimestamps()
java.lang.String	getUser()
T	setAccessToken(java.lang.String accessToken) Required to call when building MapboxMapMatching.Builder
T	setAnnotations(java.lang.String annotations)
T	setBaseUrl(java.lang.String baseUrl) Set the base url of the API.
T	setClientAppName(java.lang.String appName) Set the App Name to identify
T	setCoordinates(com.mapbox.services.commons.models.Position[] coordinates)
T	setGeometries(java.lang.String geometries)
T	setLanguage(java.lang.String language) Optionally set the language of returned turn-by-turn text instructions.
T	setOverview(java.lang.String overview)
T	setProfile(java.lang.String profile)
T	setRadiuses(double[] radiuses)
T	setSteps(java.lang.Boolean steps)
T	setTimestamps(java.lang.String[] timestamps)
T	setUser(java.lang.String user)

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:

2.0.0

Method Detail

setAccessToken

public T setAccessToken(java.lang.String accessToken)

Required to call when building MapboxMapMatching.Builder

Specified by:

setAccessToken in class MapboxBuilder

Parameters:

accessToken - Mapbox access token, you must have a Mapbox account in order to use this API.

Returns:

Builder

Since:

2.0.0

getAccessToken

public java.lang.String getAccessToken()

Specified by:

getAccessToken in class MapboxBuilder

Returns:

Mapbox access token

Since:

2.0.0

getAnnotations

public java.lang.String getAnnotations()

Returns:

annotations

setAnnotations

public T setAnnotations(java.lang.String annotations)

Parameters:

annotations - value

Returns:

Builder

getCoordinates

public java.lang.String getCoordinates()

Returns:

coordinates

setCoordinates

public T setCoordinates(com.mapbox.services.commons.models.Position[] coordinates)

Parameters:

coordinates - value

Returns:

Builder

getGeometries

public java.lang.String getGeometries()

Returns:

geometries

setGeometries

public T setGeometries(java.lang.String geometries)

Parameters:

geometries - value

Returns:

Builder

getOverview

public java.lang.String getOverview()

Returns:

overview

setOverview

public T setOverview(java.lang.String overview)

Parameters:

overview - value

Returns:

Builder

getProfile

public java.lang.String getProfile()

Returns:

profile

setProfile

public T setProfile(java.lang.String profile)

Parameters:

profile - value

Returns:

Builder

getRadiuses

public java.lang.String getRadiuses()

Returns:

radiuses

setRadiuses

public T setRadiuses(double[] radiuses)

Parameters:

radiuses - value

Returns:

Builder

getSteps

public java.lang.Boolean getSteps()

Returns:

steps

setSteps

public T setSteps(java.lang.Boolean steps)

Parameters:

steps - value

Returns:

Builder

getTimestamps

public java.lang.String getTimestamps()

Returns:

timestamps

setTimestamps

public T setTimestamps(java.lang.String[] timestamps)

Parameters:

timestamps - value

Returns:

Builder

getUser

public java.lang.String getUser()

Returns:

user

setUser

public T setUser(java.lang.String user)

Parameters:

user - value

Returns:

Builder

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:

Builder

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

setLanguage

public T setLanguage(java.lang.String language)

Optionally set the language of returned turn-by-turn text instructions. The default is en for English.

Parameters:

language - The locale in which results should be returned.

Returns:

Builder

Since:

2.2.0

See Also:

Supported languages

getLanguage

public java.lang.String getLanguage()

Returns:

The language the turn-by-turn directions will be in.

Since:

2.2.0

build

public MapboxMapMatching build()
                        throws ServicesException

Builder method

Specified by:

build in class MapboxBuilder

Returns:

MapboxMapMatching

Throws:

ServicesException - Generic Exception occurring when something with map matching goes wrong.

Since:

2.0.0