RouteOptions.Builder (services 4.3.0 API)

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()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods
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 the alternatives value was set to true or not.
`abstract RouteOptions.Builder`	`annotations(java.lang.String annotations)` The annotation which were used during the request process.
`abstract RouteOptions.Builder`	`approaches(java.lang.String approaches)` The same approaches the user originally made when the request was made.
`abstract RouteOptions.Builder`	`bannerInstructions(java.lang.Boolean bannerInstructions)` Whether or not the request had banner instructions set to true or not.
`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)` The bearing values the user used for the original request which resulted in this response.
`abstract RouteOptions`	`build()` Builds a new instance of the `RouteOptions` object.
`abstract RouteOptions.Builder`	`continueStraight(java.lang.Boolean continueStraight)` Whether the original request wanted continueStraight enabled or not.
`abstract RouteOptions.Builder`	`coordinates(java.util.List<com.mapbox.geojson.Point> coordinates)` The coordinates used for the routes origin, destination, and optionally, waypoints.
`abstract RouteOptions.Builder`	`exclude(java.lang.String exclude)` The same exclusions the user originally made when the request was made.
`abstract RouteOptions.Builder`	`geometries(java.lang.String geometries)` alter the default geometry being returned for the directions route.
`abstract RouteOptions.Builder`	`language(java.lang.String language)` The language for instructions to be in when the response is given.
`abstract RouteOptions.Builder`	`overview(java.lang.String overview)` Type of returned overview geometry that was used to make the initial directions request.
`abstract RouteOptions.Builder`	`profile(java.lang.String profile)` The directions profile that was used during the request time and resulted in this responses result.
`abstract RouteOptions.Builder`	`radiuses(java.lang.String radiuses)` The radiuses in string format that were used during the original request.
`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)` This is set to true if you want to enable instructions while exiting roundabouts and rotaries.
`abstract RouteOptions.Builder`	`steps(java.lang.Boolean steps)` Boolean value used to determine whether to return steps and turn-by-turn instructions in the initial directions request.
`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 or not the request had voice instructions set to true or not.
`abstract RouteOptions.Builder`	`voiceUnits(java.lang.String voiceUnits)` Whether or not the units used inside the voice instruction's string are in imperial or metric.
`abstract RouteOptions.Builder`	`waypointNames(java.lang.String waypointNames)` The same waypoint names the user originally made when the request was made.
`abstract RouteOptions.Builder`	`waypointTargets(java.lang.String waypointTargets)` The same waypoint targets the user originally made when the request was made.

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 directions profile that was used during the request time and resulted in this responses result.
    
    Parameters:
    
    profile - One of the direction profiles defined in DirectionsCriteria.DirectionsCriteria()
    
    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)
```
    The coordinates used for the routes origin, destination, and optionally, waypoints. Note that these coordinates are different than the direction responses DirectionsWaypoints in 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(@Nullable
                                                  java.lang.Boolean alternatives)
```
    Whether the alternatives value was set to true or not.
    
    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(java.lang.String language)
```
    The language for instructions to be in when the response is given.
    
    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(java.lang.String radiuses)
```
    The radiuses in string format that were used during the original request.
    
    Parameters:
    
    radiuses - radiuses values separated by comma
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - bearings
```
public abstract RouteOptions.Builder bearings(java.lang.String bearings)
```
    The bearing values the user used for the original request which resulted in this response. It is best to recalculate these values since they are probably outdated already.
    
    Parameters:
    
    bearings - number values representing the bearings separated by commas
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - continueStraight
```
public abstract RouteOptions.Builder continueStraight(java.lang.Boolean continueStraight)
```
    Whether the original request wanted continueStraight enabled or not.
    
    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(@Nullable
                                                     java.lang.Boolean roundaboutExits)
```
    This is set to true if you want to enable instructions while exiting roundabouts and rotaries.
    
    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(java.lang.String geometries)
```
    alter the default geometry being returned for the directions route. A null value will reset this field to the APIs default value vs this SDKs default value of DirectionsCriteria.GEOMETRY_POLYLINE6.
    
    Parameters:
    
    geometries - null if you'd like the default geometry, else 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(@Nullable
                                              java.lang.String overview)
```
    Type of returned overview geometry that was used to make the initial directions request.
    
    Parameters:
    
    overview - null or 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(@Nullable
                                           java.lang.Boolean steps)
```
    Boolean value used to determine whether to return steps and turn-by-turn instructions in the initial directions request.
    
    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(java.lang.String annotations)
```
    The annotation which were used during the request process.
    
    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
  - voiceInstructions
```
public abstract RouteOptions.Builder voiceInstructions(java.lang.Boolean voiceInstructions)
```
    Whether or not the request had voice instructions set to true or not.
    
    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(java.lang.Boolean bannerInstructions)
```
    Whether or not the request had banner instructions set to true or not.
    
    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(@Nullable
                                                java.lang.String voiceUnits)
```
    Whether or not the units used inside the voice instruction's string are in imperial or metric.
    
    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
```
@Nullable
public abstract RouteOptions.Builder exclude(@NonNull
                                                       java.lang.String exclude)
```
    The same exclusions the user originally made when the request was made.
    
    Parameters:
    
    exclude - a string matching one of the DirectionsCriteria exclusions
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - approaches
```
@Nullable
public abstract RouteOptions.Builder approaches(java.lang.String approaches)
```
    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
  - waypointNames
```
@Nullable
public abstract RouteOptions.Builder waypointNames(@Nullable
                                                             java.lang.String waypointNames)
```
    The same waypoint names the user originally made when the request was made.
    
    Parameters:
    
    waypointNames - unrestricted, curb or omitted (;)
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.3.0
  - waypointTargets
```
@Nullable
public abstract RouteOptions.Builder waypointTargets(@Nullable
                                                               java.lang.String waypointTargets)
```
    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
  - build
```
public abstract RouteOptions build()
```
    Builds a new instance of the RouteOptions object.
    
    Returns:
    
    a new RouteOptions instance
    
    Since:
    
    3.0.0

Class RouteOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

baseUrl

user

profile

coordinates

alternatives

language

radiuses

bearings

continueStraight

roundaboutExits

geometries

overview

steps

annotations

voiceInstructions

bannerInstructions

voiceUnits

accessToken

requestUuid

exclude

approaches

waypointNames

waypointTargets

build