com.mapbox.services.api.distance.v1

Class MapboxDistance.Builder<T extends MapboxDistance.Builder>

java.lang.Object

com.mapbox.services.api.MapboxBuilder

com.mapbox.services.api.distance.v1.MapboxDistance.Builder<T>

Enclosing class:

MapboxDistance

Deprecated.

replace by the Directions Matrix API.

@Deprecated
public static class MapboxDistance.Builder<T extends MapboxDistance.Builder>
extends MapboxBuilder

Builds your distance 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() Deprecated. replace by the Directions Matrix API.

Method Summary

Modifier and Type	Method and Description
MapboxDistance	build() Deprecated. replace by the Directions Matrix API.
java.lang.String	getAccessToken() Deprecated. replace by the Directions Matrix API.
okhttp3.RequestBody	getCoordinates() Deprecated.
java.lang.String	getProfile() Deprecated. replace by the Directions Matrix API.
java.lang.String	getUser() Deprecated. replace by the Directions Matrix API.
T	setAccessToken(java.lang.String accessToken) Deprecated. replace by the Directions Matrix API.
T	setBaseUrl(java.lang.String baseUrl) Deprecated. replace by the Directions Matrix API.
T	setClientAppName(java.lang.String appName) Deprecated. Set the App Name to identify
T	setCoordinates(java.util.List<com.mapbox.services.commons.models.Position> coordinates) Deprecated.
T	setProfile(java.lang.String profile) Deprecated. replace by the Directions Matrix API.
T	setUser(java.lang.String user) Deprecated. replace by the Directions Matrix API.

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

@Deprecated
public Builder()

Deprecated. replace by the Directions Matrix API.

Constructor

Since:

2.0.0

Method Detail

setUser

@Deprecated
public T setUser(java.lang.String user)

Deprecated. replace by the Directions Matrix API.

Parameters:

user - User string, by default this is set to Mapbox DirectionsCriteria.PROFILE_DEFAULT_USER.

Returns:

Builder

Since:

2.0.0

getUser

@Deprecated
public java.lang.String getUser()

Deprecated. replace by the Directions Matrix API.

Returns:

the user as String.

Since:

2.0.0

setProfile

@Deprecated
public T setProfile(java.lang.String profile)

Deprecated. replace by the Directions Matrix API.

Set a map matching profile. You should use one of the constants found in DirectionsCriteria.

Parameters:

profile - String containing A directions profile ID; either driving, walking, or cycling. Use one of the DirectionsCriteria constants.

Returns:

Builder

Since:

2.0.0

getProfile

@Deprecated
public java.lang.String getProfile()

Deprecated. replace by the Directions Matrix API.

Returns:

String containing A directions profile ID; either driving, walking, or cycling.

Since:

2.0.0

getCoordinates

public okhttp3.RequestBody getCoordinates()

Deprecated.

setCoordinates

@Deprecated
public T setCoordinates(java.util.List<com.mapbox.services.commons.models.Position> coordinates)

Deprecated.

setAccessToken

@Deprecated
public T setAccessToken(java.lang.String accessToken)

Deprecated. replace by the Directions Matrix API.

Required to call when building MapboxDistance.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

@Deprecated
public java.lang.String getAccessToken()

Deprecated. replace by the Directions Matrix API.

Specified by:

getAccessToken in class MapboxBuilder

Returns:

Mapbox access token

Since:

2.0.0

setClientAppName

public T setClientAppName(java.lang.String appName)

Deprecated.

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

@Deprecated
public T setBaseUrl(java.lang.String baseUrl)

Deprecated. replace by the Directions Matrix API.

Set the base url of the API.

Specified by:

setBaseUrl in class MapboxBuilder

Parameters:

baseUrl - base url used as end point

Returns:

Builder

Since:

2.0.0

build

@Deprecated
public MapboxDistance build()
                                 throws ServicesException

Deprecated. replace by the Directions Matrix API.

Builder method

Specified by:

build in class MapboxBuilder

Returns:

MapboxDistance

Throws:

ServicesException - Generic Exception occurring when something with the Distance API goes wrong.

Since:

2.0.0