com.mapbox.services.api.directionsmatrix.v1

Class MapboxDirectionsMatrix.Builder<T extends MapboxDirectionsMatrix.Builder>

java.lang.Object

com.mapbox.services.api.MapboxBuilder

com.mapbox.services.api.directionsmatrix.v1.MapboxDirectionsMatrix.Builder<T>

Enclosing class:

MapboxDirectionsMatrix

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

Directions Matrix v1 builder

Since:

2.1.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
MapboxDirectionsMatrix	build() Build method
java.lang.String	getAccessToken()
java.lang.String	getCoordinates() The coordinates parameter denotes the points the API will consider happens.
java.lang.String	getDestinations()
java.lang.String	getProfile()
java.lang.String	getSources()
java.lang.String	getUser()
T	setAccessToken(java.lang.String accessToken) Required to call when building MapboxDirectionsMatrix.Builder.
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(java.util.List<com.mapbox.services.commons.models.Position> coordinates) Set the list of coordinates for the directions matrix service.
T	setDestination(com.mapbox.services.commons.models.Position destination) Appends the specified destination to the end of the coordinates list.
T	setDestinations(int... destinations) Optionally pass in indexes to generate an asymmetric matrix.
T	setOrigin(com.mapbox.services.commons.models.Position origin) Inserts the specified position at the beginning of the coordinates list.
T	setProfile(java.lang.String profile)
T	setSources(int... sources) Optionally pass in indexes to generate an asymmetric matrix.
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.1.0

Method Detail

setUser

public T setUser(java.lang.String user)

Parameters:

user - User string

Returns:

Builder

Since:

2.1.0

setProfile

public T setProfile(java.lang.String profile)

Parameters:

profile - Profile string

Returns:

Builder

Since:

2.1.0

setCoordinates

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

Set the list of coordinates for the directions matrix service. If you've previously set an origin with setOrigin() or a destination with setDestination(), those will be overridden.

Parameters:

coordinates - List of Position giving origin and destination(s) coordinates.

Returns:

Builder

Since:

2.1.0

setDestinations

public T setDestinations(int... destinations)

Optionally pass in indexes to generate an asymmetric matrix.

Parameters:

destinations - 1 or more indexes as a integer, if more then one, separate with a comma.

Returns:

Builder

Since:

2.1.0

setSources

public T setSources(int... sources)

Optionally pass in indexes to generate an asymmetric matrix.

Parameters:

sources - 1 or more indexes as a integer, if more then one, separate with a comma.

Returns:

Builder

Since:

2.1.0

setOrigin

public T setOrigin(com.mapbox.services.commons.models.Position origin)

Inserts the specified position at the beginning of the coordinates list. If you've set other coordinates previously with setCoordinates() those elements are kept and their index will be moved up by one (the coordinates are moved to the right).

Parameters:

origin - Position of route origin.

Returns:

Builder

Since:

2.1.0

setDestination

public T setDestination(com.mapbox.services.commons.models.Position destination)

Appends the specified destination to the end of the coordinates list. If you've set other coordinates previously with setCoordinates() those elements are kept and the destination is added at the end of the list.

Parameters:

destination - Position of route destination.

Returns:

Builder

Since:

2.1.0

setAccessToken

public T setAccessToken(java.lang.String accessToken)

Required to call when building MapboxDirectionsMatrix.Builder.

Specified by:

setAccessToken in class MapboxBuilder

Parameters:

accessToken - Mapbox access token, You must have a Mapbox account inorder to use this library.

Returns:

Builder

Since:

2.1.0

setBaseUrl

public T setBaseUrl(java.lang.String baseUrl)

Description copied from class: MapboxBuilder

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

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

getDestinations

public java.lang.String getDestinations()

Returns:

A formatted string that contains all the destinations integers you used insider your request.

Since:

2.1.0

getSources

public java.lang.String getSources()

Returns:

A formatted string that contains all the source integers you used insider your request.

Since:

2.1.0

getCoordinates

public java.lang.String getCoordinates()

The coordinates parameter denotes the points the API will consider happens. The coordinates must be in the format:

{longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...]

- Each coordinate is a pair of a longitude double and latitude double, which are separated by a , - Coordinates are separated by a ; from each other - A query must at minimum have 2 coordinates and may at maximum have 25 coordinates

Returns:

String containing coordinates formatted.

Since:

2.1.0

getUser

public java.lang.String getUser()

Returns:

the user as String

Since:

2.1.0

getProfile

public java.lang.String getProfile()

Returns:

DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_CYCLING, or DirectionsCriteria.PROFILE_WALKING

Since:

2.1.0

getAccessToken

public java.lang.String getAccessToken()

Specified by:

getAccessToken in class MapboxBuilder

Returns:

your Mapbox access token.

Since:

2.1.0

build

public MapboxDirectionsMatrix build()
                             throws ServicesException

Build method

Specified by:

build in class MapboxBuilder

Returns:

MapboxDirectionsMatrix

Throws:

ServicesException - Generic Exception for all things directions matrix.

Since:

2.1.0