com.mapbox.api.directions.v5.models

Class RouteOptions.Builder

java.lang.Object

com.mapbox.api.directions.v5.models.RouteOptions.Builder

Enclosing class:

RouteOptions

public abstract static class RouteOptions.Builder
extends java.lang.Object

This builder can be used to set the values describing the RouteOptions.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract RouteOptions.Builder	accessToken(java.lang.String accessToken) A valid Mapbox access token used to making the request.
abstract RouteOptions.Builder	alternatives(java.lang.Boolean alternatives) Whether to try to return alternative routes (true) or not (false, default).
abstract RouteOptions.Builder	annotations(java.lang.String annotations) Whether to return additional metadata along the route.
RouteOptions.Builder	annotationsList(java.util.List<java.lang.String> annotations) Whether to return additional metadata along the route.
abstract RouteOptions.Builder	approaches(java.lang.String approaches) Indicates from which side of the road to approach a waypoint.
RouteOptions.Builder	approachesList(java.util.List<java.lang.String> approaches) Indicates from which side of the road to approach a waypoint.
abstract RouteOptions.Builder	bannerInstructions(java.lang.Boolean bannerInstructions) Whether to return banner objects associated with the route steps (true) or not (false, default).
abstract RouteOptions.Builder	baseUrl(java.lang.String baseUrl) The base URL that was used during the request time and resulted in this responses result.
abstract RouteOptions.Builder	bearings(java.lang.String bearings) Influences the direction in which a route starts from a waypoint.
RouteOptions.Builder	bearingsList(java.util.List<java.util.List<java.lang.Double>> bearings) Influences the direction in which a route starts from a waypoint.
abstract RouteOptions	build() Builds a new instance of the RouteOptions object.
abstract RouteOptions.Builder	continueStraight(java.lang.Boolean continueStraight) Sets the allowed direction of travel when departing intermediate waypoints.
abstract RouteOptions.Builder	coordinates(java.util.List<com.mapbox.geojson.Point> coordinates) A list of Points to visit in order.
abstract RouteOptions.Builder	exclude(java.lang.String exclude) Exclude certain road types from routing.
abstract RouteOptions.Builder	geometries(java.lang.String geometries) The format of the returned geometry.
abstract RouteOptions.Builder	language(java.lang.String language) The language of returned turn-by-turn text instructions.
abstract RouteOptions.Builder	overview(java.lang.String overview) Displays the requested type of overview geometry.
abstract RouteOptions.Builder	profile(java.lang.String profile) The routing profile to use.
abstract RouteOptions.Builder	radiuses(java.lang.String radiuses) The maximum distance a coordinate can be moved to snap to the road network in meters.
RouteOptions.Builder	radiusesList(java.util.List<java.lang.Double> radiuses) The maximum distance a coordinate can be moved to snap to the road network in meters.
abstract RouteOptions.Builder	requestUuid(java.lang.String requestUuid) A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
abstract RouteOptions.Builder	roundaboutExits(java.lang.Boolean roundaboutExits) Whether to emit instructions at roundabout exits (true) or not (false, default).
abstract RouteOptions.Builder	steps(java.lang.Boolean steps) Whether to return steps and turn-by-turn instructions (true) or not (false, default).
abstract RouteOptions.Builder	user(java.lang.String user) The user value that was used during the request.
abstract RouteOptions.Builder	voiceInstructions(java.lang.Boolean voiceInstructions) Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default).
abstract RouteOptions.Builder	voiceUnits(java.lang.String voiceUnits) Specify which type of units to return in the text for voice instructions.
abstract RouteOptions.Builder	walkingOptions(WalkingOptions walkingOptions) To be used to specify settings for use with the walking profile.
abstract RouteOptions.Builder	waypointIndices(java.lang.String waypointIndices) Indicates which input coordinates should be treated as waypoints.
RouteOptions.Builder	waypointIndicesList(java.util.List<java.lang.Integer> indices) Indicates which input coordinates should be treated as waypoints.
abstract RouteOptions.Builder	waypointNames(java.lang.String waypointNames) A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions.
RouteOptions.Builder	waypointNamesList(java.util.List<java.lang.String> waypointNames) A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions.
abstract RouteOptions.Builder	waypointTargets(java.lang.String waypointTargets) A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates.
RouteOptions.Builder	waypointTargetsList(java.util.List<com.mapbox.geojson.Point> waypointTargets) A list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

baseUrl

public abstract RouteOptions.Builder baseUrl(@NonNull
                                             java.lang.String baseUrl)

The base URL that was used during the request time and resulted in this responses result.

Parameters:

baseUrl - base URL used for original request

Returns:

this builder for chaining options together

Since:

3.0.0

user

public abstract RouteOptions.Builder user(@NonNull
                                          java.lang.String user)

The user value that was used during the request.

Parameters:

user - string representing the user field in the calling url

Returns:

this builder for chaining options together

Since:

3.0.0

profile

public abstract RouteOptions.Builder profile(@NonNull
                                             java.lang.String profile)

The routing profile to use. Possible values are DirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_WALKING, or DirectionsCriteria.PROFILE_CYCLING. The same profile which was used during the request that resulted in this root directions response. MapboxDirections.Builder ensures that a profile is always set even if the MapboxDirections requesting object doesn't specifically set a profile.

Parameters:

profile - One of the direction profiles defined in DirectionsCriteria.ProfileCriteria

Returns:

this builder for chaining options together

Since:

3.0.0

coordinates

public abstract RouteOptions.Builder coordinates(@NonNull
                                                 java.util.List<com.mapbox.geojson.Point> coordinates)

A list of Points to visit in order. There can be between two and 25 coordinates for most requests, or up to three coordinates for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC requests. Note that these coordinates are different than the direction responses DirectionsWaypoints that these are the non-snapped coordinates.

Parameters:

coordinates - a list of Points which represent the route origin, destination, and optionally, waypoints

Returns:

this builder for chaining options together

Since:

3.0.0

alternatives

public abstract RouteOptions.Builder alternatives(@NonNull
                                                  java.lang.Boolean alternatives)

Whether to try to return alternative routes (true) or not (false, default). An alternative route is a route that is significantly different than the fastest route, but also still reasonably fast. Such a route does not exist in all circumstances. Up to two alternatives may be returned. This is available forDirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_CYCLING.

Parameters:

alternatives - true if the request contained additional route request, otherwise false

Returns:

this builder for chaining options together

Since:

3.0.0

language

public abstract RouteOptions.Builder language(@NonNull
                                              java.lang.String language)

The language of returned turn-by-turn text instructions. The default is en (English). Must be used in conjunction with RouteOptions.steps() = true.

Parameters:

language - a string with the language which was requested in the url

Returns:

this builder for chaining options together

Since:

3.0.0

radiuses

public abstract RouteOptions.Builder radiuses(@NonNull
                                              java.lang.String radiuses)

The maximum distance a coordinate can be moved to snap to the road network in meters. There must be as many radiuses as there are coordinates in the request, each separated by ;. Values can be any number greater than 0 or the string unlimited.

Parameters:

radiuses - a String of radius values, each separated by ;.

Returns:

this builder for chaining options together

Since:

3.0.0

radiusesList

public RouteOptions.Builder radiusesList(@NonNull
                                         java.util.List<java.lang.Double> radiuses)

The maximum distance a coordinate can be moved to snap to the road network in meters. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or Double.POSITIVE_INFINITY.

Parameters:

radiuses - a list of radius values

Returns:

this builder for chaining options together

bearings

public abstract RouteOptions.Builder bearings(@NonNull
                                              java.lang.String bearings)

Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles 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. Takes two comma-separated values per waypoint: an angle clockwise from true north between 0 and 360, and the range of degrees by which the angle can deviate (recommended value is 45° or 90°), formatted as {angle, degrees}. If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the ; separator.

Parameters:

bearings - a string representing the bearings with the ; separator. Angle and degrees for every bearing value are comma-separated.

Returns:

this builder for chaining options together

Since:

3.0.0

bearingsList

public RouteOptions.Builder bearingsList(@NonNull
                                         java.util.List<java.util.List<java.lang.Double>> bearings)

Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles 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. Takes a List of list of doubles: the first value in the list is an angle clockwise from true north between 0 and 360, the second value is the range of degrees by which the angle can deviate (recommended value is 45° or 90°). If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the null value.

Parameters:

bearings - a List of list of doubles representing the bearings used in the original request. The first value in the list is the angle, the second one is the degrees.

Returns:

this builder for chaining options together

continueStraight

public abstract RouteOptions.Builder continueStraight(@NonNull
                                                      java.lang.Boolean continueStraight)

Sets the allowed direction of travel when departing intermediate waypoints. If true, the route will continue in the same direction of travel. If false, the route may continue in the opposite direction of travel. Defaults to true for DirectionsCriteria.PROFILE_DRIVING and false for DirectionsCriteria.PROFILE_WALKING and DirectionsCriteria.PROFILE_CYCLING.

Parameters:

continueStraight - true if you'd like the user to continue straight from the starting point

Returns:

this builder for chaining options together

Since:

3.0.0

roundaboutExits

public abstract RouteOptions.Builder roundaboutExits(@NonNull
                                                     java.lang.Boolean roundaboutExits)

Whether to emit instructions at roundabout exits (true) or not (false, default). Without this parameter, roundabout maneuvers are given as a single instruction that includes both entering and exiting the roundabout. With roundabout_exits=true, this maneuver becomes two instructions, one for entering the roundabout and one for exiting it. Must be used in conjunction with steps(Boolean)

Parameters:

roundaboutExits - true if you'd like extra roundabout instructions

Returns:

this builder for chaining options together

Since:

3.1.0

geometries

public abstract RouteOptions.Builder geometries(@NonNull
                                                java.lang.String geometries)

The format of the returned geometry. Allowed values are: DirectionsCriteria.GEOMETRY_POLYLINE (default, a polyline with a precision of five decimal places), DirectionsCriteria.GEOMETRY_POLYLINE6 (a polyline with a precision of six decimal places). A null value will reset this field to the APIs default value vs this SDKs default value of DirectionsCriteria.GEOMETRY_POLYLINE6.

Parameters:

geometries - one of the options found in DirectionsCriteria.GeometriesCriteria.

Returns:

this builder for chaining options together

Since:

3.1.0

overview

public abstract RouteOptions.Builder overview(@NonNull
                                              java.lang.String overview)

Displays the requested type of overview geometry. Can be DirectionsCriteria.OVERVIEW_FULL (the most detailed geometry available), DirectionsCriteria.OVERVIEW_SIMPLIFIED (default, a simplified version of the full geometry), or DirectionsCriteria.OVERVIEW_FALSE (no overview geometry).

Parameters:

overview - one of the options found in DirectionsCriteria.OverviewCriteria

Returns:

this builder for chaining options together

Since:

3.1.0

steps

public abstract RouteOptions.Builder steps(@NonNull
                                           java.lang.Boolean steps)

Whether to return steps and turn-by-turn instructions (true) or not (false, default). If steps is set to true, the following guidance-related parameters will be available: RouteOptions.bannerInstructions(), RouteOptions.language(), RouteOptions.roundaboutExits(), RouteOptions.voiceInstructions(), RouteOptions.voiceUnits(), RouteOptions.waypointNamesList(), RouteOptions.waypointTargetsList(), waypoints from RouteOptions.coordinates()

Parameters:

steps - true if you'd like step information, false otherwise

Returns:

this builder for chaining options together

Since:

3.1.0

annotations

public abstract RouteOptions.Builder annotations(@NonNull
                                                 java.lang.String annotations)

Whether to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DURATION DirectionsCriteria.ANNOTATION_DISTANCE DirectionsCriteria.ANNOTATION_SPEED DirectionsCriteria.ANNOTATION_CONGESTION DirectionsCriteria.ANNOTATION_MAXSPEED You can include several annotations as a comma-separated list. See the RouteLeg object for more details on what is included with annotations. Must be used in conjunction with overview=full.

Parameters:

annotations - in string format and separated by commas if more than one annotation was requested

Returns:

this builder for chaining options together

Since:

3.0.0

annotationsList

public RouteOptions.Builder annotationsList(@NonNull
                                            java.util.List<java.lang.String> annotations)

Whether to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DURATION DirectionsCriteria.ANNOTATION_DISTANCE DirectionsCriteria.ANNOTATION_SPEED DirectionsCriteria.ANNOTATION_CONGESTION DirectionsCriteria.ANNOTATION_MAXSPEED See the RouteLeg object for more details on what is included with annotations. Must be used in conjunction with overview=full.

Parameters:

annotations - a list of annotations

Returns:

this builder for chaining options together

voiceInstructions

public abstract RouteOptions.Builder voiceInstructions(@NonNull
                                                       java.lang.Boolean voiceInstructions)

Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default). Must be used in conjunction with steps(Boolean).

Parameters:

voiceInstructions - true if the original request included voice instructions

Returns:

this builder for chaining options together

Since:

3.0.0

bannerInstructions

public abstract RouteOptions.Builder bannerInstructions(@NonNull
                                                        java.lang.Boolean bannerInstructions)

Whether to return banner objects associated with the route steps (true) or not (false, default). Must be used in conjunction with steps(Boolean)

Parameters:

bannerInstructions - true if the original request included banner instructions

Returns:

this builder for chaining options together

Since:

3.0.0

voiceUnits

public abstract RouteOptions.Builder voiceUnits(@NonNull
                                                java.lang.String voiceUnits)

Specify which type of units to return in the text for voice instructions. Can be DirectionsCriteria.IMPERIAL (default) or DirectionsCriteria.METRIC. Must be used in conjunction with steps(Boolean)=true and voiceInstructions(Boolean)=true.

Parameters:

voiceUnits - string matching either imperial or metric

Returns:

this builder for chaining options together

Since:

3.0.0

accessToken

public abstract RouteOptions.Builder accessToken(@NonNull
                                                 java.lang.String accessToken)

A valid Mapbox access token used to making the request.

Parameters:

accessToken - a string containing a valid Mapbox access token

Returns:

this builder for chaining options together

Since:

3.0.0

requestUuid

public abstract RouteOptions.Builder requestUuid(@NonNull
                                                 java.lang.String requestUuid)

A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.

Parameters:

requestUuid - a string containing the request UUID

Returns:

this builder for chaining options together

Since:

3.0.0

exclude

public abstract RouteOptions.Builder exclude(@NonNull
                                             java.lang.String exclude)

Exclude certain road types from routing. The default is to not exclude anything from the profile selected. The following exclude flags are available for each profile: DirectionsCriteria.PROFILE_DRIVING: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY. DirectionsCriteria.PROFILE_DRIVING_TRAFFIC: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY. DirectionsCriteria.PROFILE_WALKING: No excludes supported DirectionsCriteria.PROFILE_CYCLING: DirectionsCriteria.EXCLUDE_FERRY

Parameters:

exclude - a string matching one of the DirectionsCriteria.ExcludeCriteria exclusions

Returns:

this builder for chaining options together

Since:

3.0.0

approaches

public abstract RouteOptions.Builder approaches(@NonNull
                                                java.lang.String approaches)

Indicates from which side of the road to approach a waypoint. Accepts DirectionsCriteria.APPROACH_UNRESTRICTED (default) or DirectionsCriteria.APPROACH_CURB . If set to DirectionsCriteria.APPROACH_UNRESTRICTED, the route can approach waypoints from either side of the road. If set to DirectionsCriteria.APPROACH_CURB, the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator. The same approaches the user originally made when the request was made.

Parameters:

approaches - unrestricted, curb or omitted (;)

Returns:

this builder for chaining options together

Since:

3.2.0

approachesList

public RouteOptions.Builder approachesList(@NonNull
                                           java.util.List<java.lang.String> approaches)

Indicates from which side of the road to approach a waypoint. Accepts DirectionsCriteria.APPROACH_UNRESTRICTED (default) or DirectionsCriteria.APPROACH_CURB . If set to DirectionsCriteria.APPROACH_UNRESTRICTED, the route can approach waypoints from either side of the road. If set to DirectionsCriteria.APPROACH_CURB, the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints. However, you can skip a coordinate and show its position in the list with null value. The same approaches the user originally made when the request was made.

Parameters:

approaches - a list of Strings

Returns:

this builder for chaining options together

waypointIndices

public abstract RouteOptions.Builder waypointIndices(@NonNull
                                                     java.lang.String waypointIndices)

Indicates which input coordinates should be treated as waypoints.

Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates' index separated by ; . RouteOptions.steps()

The same waypoint indices the user originally made when the request was made.

Parameters:

waypointIndices - to be used as waypoints

Returns:

this builder for chaining options together

Since:

4.4.0

waypointIndicesList

public RouteOptions.Builder waypointIndicesList(@NonNull
                                                java.util.List<java.lang.Integer> indices)

Indicates which input coordinates should be treated as waypoints.

Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates'. RouteOptions.steps()

The same waypoint indices the user originally made when the request was made.

Parameters:

indices - a list to be used as waypoints

Returns:

this builder for chaining options together

waypointNames

public abstract RouteOptions.Builder waypointNames(@NonNull
                                                   java.lang.String waypointNames)

A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of waypoint_names must be the same length as the list of coordinates, but you can skip a coordinate pair and show its position in the list with the ; separator. The first value in the list corresponds to the route origin, not the first destination. To leave the origin unnamed, begin the list with a semicolon. Must be used in conjunction with steps(Boolean) = true.

Parameters:

waypointNames - unrestricted, curb or omitted (;)

Returns:

this builder for chaining options together

Since:

3.3.0

waypointNamesList

public RouteOptions.Builder waypointNamesList(@NonNull
                                              java.util.List<java.lang.String> waypointNames)

A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of waypoint_names must be the same length as the list of coordinates, but you can skip a coordinate pair and show its position in the list with the null value. The first value in the list corresponds to the route origin, not the first destination. To leave the origin unnamed, begin the list with a null value. Must be used in conjunction with steps(Boolean) = true.

Parameters:

waypointNames - a list of Strings

Returns:

this builder for chaining options together

waypointTargets

public abstract RouteOptions.Builder waypointTargets(@NonNull
                                                     java.lang.String waypointTargets)

A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate pair and show its position in the list with the ; separator. Must be used with steps(Boolean) = true. The same waypoint targets the user originally made when the request was made.

Parameters:

waypointTargets - list of coordinate pairs for drop-off locations (;)

Returns:

this builder for chaining options together

Since:

4.3.0

waypointTargetsList

public RouteOptions.Builder waypointTargetsList(@NonNull
                                                java.util.List<com.mapbox.geojson.Point> waypointTargets)

A list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate pair and show its position in the list with the null value. Must be used with steps(Boolean) = true. The same waypoint targets the user originally made when the request was made.

Parameters:

waypointTargets - list of Points for drop-off locations

Returns:

this builder for chaining options together

walkingOptions

public abstract RouteOptions.Builder walkingOptions(@NonNull
                                                    WalkingOptions walkingOptions)

To be used to specify settings for use with the walking profile.

Parameters:

walkingOptions - options to use for walking profile

Returns:

this builder for chaining options together

Since:

4.8.0

build

public abstract RouteOptions build()

Builds a new instance of the RouteOptions object.

Returns:

a new RouteOptions instance

Since:

3.0.0