com.mapbox.services.api.directions.v5

Class MapboxDirections.Builder<T extends MapboxDirections.Builder>

java.lang.Object

com.mapbox.services.api.MapboxBuilder

com.mapbox.services.api.directions.v5.MapboxDirections.Builder<T>

Enclosing class:

MapboxDirections

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

Directions v5 builder

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

Method Summary

Modifier and Type	Method and Description
MapboxDirections	build() Build method
java.lang.String	getAccessToken()
java.lang.String	getAnnotation() returns one or a combination of DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, or DirectionsCriteria.ANNOTATION_SPEED.
java.lang.String	getBearings()
java.lang.String	getCoordinates() The coordinates parameter denotes between which points routing happens.
java.lang.String	getGeometries()
java.lang.String	getLanguage()
java.lang.String	getOverview()
java.lang.String	getProfile() The current profile set for usage with the Directions API.
java.lang.String	getRadiuses() Radiuses indicate how far from a coordinate a routeable way is searched.
java.lang.String	getUser()
java.lang.Boolean	isAlternatives()
java.lang.Boolean	isContinueStraight() Determine whether the route's been set to continue straight or not.
java.lang.Boolean	isSteps()
T	setAccessToken(java.lang.String accessToken) Required to call when building MapboxDirections.Builder.
T	setAlternatives(java.lang.Boolean alternatives) Optionally, call if you'd like to receive alternative routes besides just one.
T	setAnnotation(java.lang.String... annotation) Whether or not to return additional metadata along the route.
T	setBaseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Mapbox one.
T	setBearings(double[]... bearings) Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach.
T	setClientAppName(java.lang.String appName) Base package name or other simple string identifier
T	setContinueStraight(java.lang.Boolean continueStraight) Toggle whether you want the route to always continue straight toward the next destination or allow for backtracking.
T	setCoordinates(java.util.List<com.mapbox.services.commons.models.Position> coordinates) Set the list of coordinates for the directions service.
T	setDestination(com.mapbox.services.commons.models.Position destination) Appends the specified destination to the end of the coordinates list.
T	setGeometry(java.lang.String geometries) The SDK currently only supports Polyline geometry (not GeoJSON) to simplify the response.
T	setLanguage(java.lang.String language) Optionally set the language of returned turn-by-turn text instructions.
T	setOrigin(com.mapbox.services.commons.models.Position origin) Inserts the specified position at the beginning of the coordinates list.
T	setOverview(java.lang.String overview) Optionally, set whether you want the route geometry to be full, simplified, etc.
T	setProfile(java.lang.String profile)
T	setRadiuses(double[] radiuses) Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment.
T	setSteps(java.lang.Boolean steps) Optionally, call if you'd like to include step information within route.
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:

1.0.0

Method Detail

setGeometry

public T setGeometry(java.lang.String geometries)

The SDK currently only supports Polyline geometry (not GeoJSON) to simplify the response. You do have the option on whether the precision is 5 or 6 using either DirectionsCriteria.GEOMETRY_POLYLINE or DirectionsCriteria.GEOMETRY_POLYLINE6.

Parameters:

geometries - A String constant which equals either "polyline" or "polyline6".

Returns:

Builder

Since:

2.0.0

setUser

public T setUser(java.lang.String user)

Parameters:

user - User string

Returns:

Builder

Since:

1.0.0

setProfile

public T setProfile(java.lang.String profile)

Parameters:

profile - Profile string

Returns:

Builder

Since:

1.0.0

setCoordinates

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

Set the list of coordinates for the directions 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:

1.0.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:

1.0.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:

1.0.0

setAccessToken

public T setAccessToken(java.lang.String accessToken)

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

1.0.0

setAlternatives

public T setAlternatives(java.lang.Boolean alternatives)

Optionally, call if you'd like to receive alternative routes besides just one.

Parameters:

alternatives - true if you'd like alternative routes, else false.

Returns:

Builder

Since:

1.0.0

setOverview

public T setOverview(java.lang.String overview)

Optionally, set whether you want the route geometry to be full, simplified, etc.

Parameters:

overview - String defining type of overview you'd like the API to give. Use one of the constants.

Returns:

Builder

Since:

1.0.0

setBearings

public T setBearings(double[]... bearings)

Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach. This option should always be used in conjunction with the setRadiuses(double[]) parameter. The parameter takes two values per waypoint: the first is an angle clockwise from true north between 0 and 360. The second is the range of degrees the angle can deviate by. We recommend a value of 45 degrees or 90 degrees for the range, as bearing measurements tend to be inaccurate. This is useful for making sure we reroute vehicles on new routes that continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. If provided, the list of bearings must be the same length as the list of waypoints, but you can skip a coordinate and show its position by passing in a double array with no values included like so: new double[] {}.

Parameters:

bearings - a double array with two values indicating the angle and the other value indicating the deviating range.

Returns:

Builder

Since:

2.0.0

setRadiuses

public T setRadiuses(double[] radiuses)

Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or they can be unlimited simply by passing Double.POSITIVE_INFINITY. If no routable road is found within the radius, a NoSegment error is returned.

Parameters:

radiuses - double array containing the radiuses defined in unit meters.

Returns:

Builder

Since:

1.0.0

setSteps

public T setSteps(java.lang.Boolean steps)

Optionally, call if you'd like to include step information within route.

Parameters:

steps - true if you'd like step information.

Returns:

Builder

Since:

1.0.0

setContinueStraight

public T setContinueStraight(java.lang.Boolean continueStraight)

Toggle whether you want the route to always continue straight toward the next destination or allow for backtracking.

Parameters:

continueStraight - boolean true if you want to always continue straight, else false.

Returns:

Builder

Since:

1.0.0

setAnnotation

public T setAnnotation(java.lang.String... annotation)

Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, DirectionsCriteria.ANNOTATION_DURATION and DirectionsCriteria.ANNOTATION_CONGESTION. Several annotation can be used by separating them with ,.

Parameters:

annotation - String referencing one of the annotation direction criteria's.

Returns:

Builder

Since:

2.1.0

See Also:

RouteLeg object documentation

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

getUser

public java.lang.String getUser()

Returns:

the user as String

Since:

1.0.0

getProfile

public java.lang.String getProfile()

The current profile set for usage with the Directions API.

Returns:

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

Since:

1.0.0

getCoordinates

public java.lang.String getCoordinates()

The coordinates parameter denotes between which points routing 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 have at least 2 coordinates and at most 25 coordinates (at most 3 when the profile is DirectionsCriteria.PROFILE_DRIVING_TRAFFIC)

Returns:

String containing coordinates formatted.

Since:

1.0.0

getAccessToken

public java.lang.String getAccessToken()

Specified by:

getAccessToken in class MapboxBuilder

Returns:

your Mapbox access token.

Since:

1.0.0

isAlternatives

public java.lang.Boolean isAlternatives()

Returns:

true if you setAlternatives(Boolean) to true.

Since:

1.0.0

getGeometries

public java.lang.String getGeometries()

Returns:

DirectionsCriteria.GEOMETRY_GEOJSON, DirectionsCriteria.GEOMETRY_POLYLINE, or DirectionsCriteria.GEOMETRY_POLYLINE6

Since:

1.0.0

getOverview

public java.lang.String getOverview()

Returns:

The overview, full, simplied, etc.

Since:

1.0.0

getBearings

public java.lang.String getBearings()

Returns:

The optional bearing values if given, otherwise null.

Since:

2.0.0

getRadiuses

public java.lang.String getRadiuses()

Radiuses indicate how far from a coordinate a routeable way is searched. They are indicated like this:

?radiuses={radius};{radius}}[;{radius} ...].

If no routeble way can be found within the serach radius, a NoRoute error will be returned. - Radiuses are separated by a , - Each radius must be of a value float >= 0 in meters or unlimited (default) - There must be as many radiuses as there are coordinates - It is possible to not specify radiuses via ;;, which result in the same behaviour as setting unlimited

Returns:

String containing formatted radiuses.

Since:

1.0.0

isSteps

public java.lang.Boolean isSteps()

Returns:

true if you requested step information in setSteps(Boolean).

Since:

1.0.0

isContinueStraight

public java.lang.Boolean isContinueStraight()

Determine whether the route's been set to continue straight or not.

Returns:

true if continuing straight, otherwise false.

Since:

1.0.0

getAnnotation

public java.lang.String getAnnotation()

returns one or a combination of DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, or DirectionsCriteria.ANNOTATION_SPEED.

Returns:

String with 1 or several annotations that have been set.

Since:

2.1.0

getLanguage

public java.lang.String getLanguage()

Returns:

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

Since:

2.2.0

setClientAppName

public T setClientAppName(java.lang.String appName)

Base package name or other simple string identifier

Specified by:

setClientAppName in class MapboxBuilder

Parameters:

appName - base package name or other simple string identifier

Returns:

Builder

Since:

1.3.0

setBaseUrl

public T setBaseUrl(java.lang.String baseUrl)

Optionally change the APIs base URL to something other then the default Mapbox one.

Specified by:

setBaseUrl in class MapboxBuilder

Parameters:

baseUrl - base url used as end point

Returns:

Builder

Since:

1.3.0

build

public MapboxDirections build()
                       throws ServicesException

Build method

Specified by:

build in class MapboxBuilder

Returns:

MapboxDirections

Throws:

ServicesException - Generic Exception for all things directions.

Since:

1.0.0