RouteOptions (services-directions-models API)

java.lang.Object
- com.mapbox.api.directions.v5.models.DirectionsJsonObject
- - com.mapbox.api.directions.v5.models.RouteOptions

All Implemented Interfaces:

java.io.Serializable
```
public abstract class RouteOptions
extends DirectionsJsonObject
```
Provides information connected to your request that help when a new directions request is needing using the identical parameters as the original request.
For example, if I request a driving (profile) with alternatives and continueStraight set to true. I make the request but loose reference and information which built the original request. Thus, If I only want to change a single variable such as the destination coordinate, i'd have to have all the other route information stores so the request was made identical to the previous but only now using this new destination point.
Using this class can provide you wth the information used when the DirectionsRoute was made.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`RouteOptions.Builder` This builder can be used to set the values describing the `RouteOptions`.

Constructor Summary

Constructors
Constructor and Description

RouteOptions()

Constructors
Constructor and Description
`RouteOptions()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.String`	`accessToken()` A valid Mapbox access token used to making the request.
`abstract java.lang.Boolean`	`alternatives()` Whether to try to return alternative routes (true) or not (false, default).
`abstract java.lang.String`	`annotations()` A comma-separated list of annotations.
`java.util.List<java.lang.String>`	`annotationsList()` A list of annotations.
`abstract java.lang.String`	`approaches()` Indicates from which side of the road to approach a waypoint.
`java.util.List<java.lang.String>`	`approachesList()` Indicates from which side of the road to approach a waypoint.
`abstract java.lang.Boolean`	`bannerInstructions()` Whether to return banner objects associated with the route steps (true) or not (false, default).
`abstract java.lang.String`	`baseUrl()` The same base URL which was used during the request that resulted in this root directions response.
`abstract java.lang.String`	`bearings()` Influences the direction in which a route starts from a waypoint.
`java.util.List<java.util.List<java.lang.Double>>`	`bearingsList()` Influences the direction in which a route starts from a waypoint.
`static RouteOptions.Builder`	`builder()` Build a new instance of this RouteOptions class optionally settling values.
`abstract java.lang.Boolean`	`continueStraight()` The allowed direction of travel when departing intermediate waypoints.
`abstract java.util.List<com.mapbox.geojson.Point>`	`coordinates()` A list of Points to visit in order.
`abstract java.lang.String`	`exclude()` Exclude certain road types from routing.
`static RouteOptions`	`fromJson(java.lang.String json)` Create a new instance of this class by passing in a formatted valid JSON String.
`abstract java.lang.String`	`geometries()` The format of the returned geometry.
`abstract java.lang.String`	`language()` The language of returned turn-by-turn text instructions.
`abstract java.lang.String`	`overview()` Displays the requested type of overview geometry.
`abstract java.lang.String`	`profile()` The routing profile to use.
`abstract java.lang.String`	`radiuses()` The maximum distance a coordinate can be moved to snap to the road network in meters.
`java.util.List<java.lang.Double>`	`radiusesList()` The maximum distance a coordinate can be moved to snap to the road network in meters.
`abstract java.lang.String`	`requestUuid()` A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
`abstract java.lang.Boolean`	`roundaboutExits()` Whether to emit instructions at roundabout exits (true) or not (false, default).
`abstract java.lang.Boolean`	`steps()` Whether to return steps and turn-by-turn instructions (true) or not (false, default).
`abstract RouteOptions.Builder`	`toBuilder()` Convert the current `RouteOptions` to its builder holding the currently assigned values.
`static com.google.gson.TypeAdapter<RouteOptions>`	`typeAdapter(com.google.gson.Gson gson)` Gson type adapter for parsing Gson to this class.
`abstract java.lang.String`	`user()` The same user which was used during the request that resulted in this root directions response.
`abstract java.lang.Boolean`	`voiceInstructions()` Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default).
`abstract java.lang.String`	`voiceUnits()` A type of units to return in the text for voice instructions.
`abstract WalkingOptions`	`walkingOptions()` To be used to specify settings for use with the walking profile.
`abstract java.lang.String`	`waypointIndices()` Indicates which input coordinates should be treated as waypoints.
`java.util.List<java.lang.Integer>`	`waypointIndicesList()` Indicates which input coordinates should be treated as waypoints.
`abstract java.lang.String`	`waypointNames()` A semicolon-separated list of custom names for entries in the list of `coordinates()`, used for the arrival instruction in banners and voice instructions.
`java.util.List<java.lang.String>`	`waypointNamesList()` A semicolon-separated list of custom names for entries in the list of `coordinates()`, used for the arrival instruction in banners and voice instructions.
`abstract 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.
`java.util.List<com.mapbox.geojson.Point>`	`waypointTargetsList()` A list of points used to specify drop-off locations that are distinct from the locations specified in coordinates.

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject
toJson

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RouteOptions
```
public RouteOptions()
```
- Method Detail
  - builder
```
public static RouteOptions.Builder builder()
```
    Build a new instance of this RouteOptions class optionally settling values.
    
    Returns:
    
    RouteOptions.Builder
    
    Since:
    
    3.0.0
  - baseUrl
```
@NonNull
public abstract java.lang.String baseUrl()
```
    The same base URL which was used during the request that resulted in this root directions response.
    
    Returns:
    
    string value representing the base URL
    
    Since:
    
    3.0.0
  - user
```
@NonNull
public abstract java.lang.String user()
```
    The same user which was used during the request that resulted in this root directions response.
    
    Returns:
    
    string value representing the user
    
    Since:
    
    3.0.0
  - profile
```
@NonNull
public abstract 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.
    
    Returns:
    
    string value representing the profile defined in DirectionsCriteria.ProfileCriteria
    
    Since:
    
    3.0.0
  - coordinates
```
@NonNull
public abstract 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.
    
    Returns:
    
    a list of Points which represent the route origin, destination, and optionally, waypoints
    
    Since:
    
    3.0.0
  - alternatives
```
@Nullable
public abstract 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 for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_CYCLING.
    
    Returns:
    
    boolean object representing the setting for alternatives
    
    Since:
    
    3.0.0
  - language
```
@Nullable
public abstract 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.Builder.steps(Boolean).
    
    Returns:
    
    the language as a string used during the request, if english, this will most likely be empty
    
    Since:
    
    3.0.0
  - radiuses
```
@Nullable
public abstract 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, the string unlimited or empty string.
    
    Returns:
    
    a string representing the radiuses separated by ;.
    
    Since:
    
    3.0.0
  - radiusesList
```
@Nullable
public java.util.List<java.lang.Double> radiusesList()
```
    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, the string unlimited, or null.
    
    Returns:
    
    a list of radiuses
  - bearings
```
@Nullable
public abstract 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. Returns 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.
    
    Returns:
    
    a string representing the bearings with the ; separator. Angle and degrees for every bearing value are comma-separated.
    
    Since:
    
    3.0.0
  - bearingsList
```
@Nullable
public java.util.List<java.util.List<java.lang.Double>> bearingsList()
```
    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. Returns a list of values, each value is a list of 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°). If provided, the list of bearings must be the same length as the list of coordinates.
    
    Returns:
    
    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.
  - continueStraight
```
@SerializedName(value="continue_straight")
 @Nullable
public abstract java.lang.Boolean continueStraight()
```
    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.
    
    Returns:
    
    a boolean value representing whether or not continueStraight was enabled or not during the initial request
    
    Since:
    
    3.0.0
  - roundaboutExits
```
@SerializedName(value="roundabout_exits")
 @Nullable
public abstract 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()=true.
    
    Returns:
    
    a boolean value representing whether or not roundaboutExits was enabled or disabled during the initial route request
    
    Since:
    
    3.1.0
  - geometries
```
@Nullable
public abstract 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).
    
    Returns:
    
    String geometry type from DirectionsCriteria.GeometriesCriteria.
    
    Since:
    
    3.1.0
  - overview
```
@Nullable
public abstract 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).
    
    Returns:
    
    null or one of the options found in DirectionsCriteria.OverviewCriteria
    
    Since:
    
    3.1.0
  - steps
```
@Nullable
public abstract 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: bannerInstructions(), language(), roundaboutExits(), voiceInstructions(), voiceUnits(), waypointNamesList(), waypointTargetsList(), waypoints from coordinates()
    
    Returns:
    
    true if you'd like step information, false otherwise
    
    Since:
    
    3.1.0
  - annotations
```
@Nullable
public abstract java.lang.String annotations()
```
    A comma-separated list of annotations. Defines 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.
    
    Returns:
    
    a string containing any of the annotations that were used during the request
    
    Since:
    
    3.0.0
  - annotationsList
```
@Nullable
public java.util.List<java.lang.String> annotationsList()
```
    A list of annotations. Defines 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.
    
    Returns:
    
    a list of annotations that were used during the request
  - exclude
```
@Nullable
public abstract 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
    
    Returns:
    
    a string matching one of the DirectionsCriteria.ExcludeCriteria exclusions
    
    Since:
    
    3.0.0
  - voiceInstructions
```
@SerializedName(value="voice_instructions")
 @Nullable
public abstract 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()=true.
    
    Returns:
    
    true if the original request included voice instructions
    
    Since:
    
    3.0.0
  - bannerInstructions
```
@SerializedName(value="banner_instructions")
 @Nullable
public abstract 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()=true
    
    Returns:
    
    true if the original request included banner instructions
    
    Since:
    
    3.0.0
  - voiceUnits
```
@SerializedName(value="voice_units")
 @Nullable
public abstract java.lang.String voiceUnits()
```
    A 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()=true and voiceInstructions() ()}=true.
    
    Returns:
    
    a string matching either imperial or metric
    
    Since:
    
    3.0.0
  - accessToken
```
@SerializedName(value="access_token")
 @NonNull
public abstract java.lang.String accessToken()
```
    A valid Mapbox access token used to making the request.
    
    Returns:
    
    a string representing the Mapbox access token
    
    Since:
    
    3.0.0
  - requestUuid
```
@SerializedName(value="uuid")
 @Nullable
public abstract java.lang.String requestUuid()
```
    A universally unique identifier (UUID) for identifying and executing a similar specific route in the future. MapboxDirections always waits for the response object which ensures this value will never be null.
    
    Returns:
    
    a string containing the request UUID
    
    Since:
    
    3.0.0
  - approaches
```
@Nullable
public abstract 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.
    
    Returns:
    
    a string representing approaches for each waypoint
    
    Since:
    
    3.2.0
  - approachesList
```
@Nullable
public java.util.List<java.lang.String> approachesList()
```
    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.
    
    Returns:
    
    a list of strings representing approaches for each waypoint
  - waypointIndices
```
@SerializedName(value="waypoints")
 @Nullable
public abstract 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 ; . steps()
    
    Returns:
    
    a string representing indices to be used as waypoints
    
    Since:
    
    4.4.0
  - waypointIndicesList
```
@Nullable
public java.util.List<java.lang.Integer> waypointIndicesList()
```
    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. steps()
    
    Returns:
    
    a List of Integers representing indices to be used as waypoints
  - waypointNames
```
@SerializedName(value="waypoint_names")
 @Nullable
public abstract java.lang.String waypointNames()
```
    A semicolon-separated list of custom names for entries in the list of 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. The first value in the list corresponds to the route origin, not the first destination. Must be used in conjunction with steps() = true.
    
    Returns:
    
    a string representing names for each waypoint
    
    Since:
    
    3.3.0
  - waypointNamesList
```
@Nullable
public java.util.List<java.lang.String> waypointNamesList()
```
    A semicolon-separated list of custom names for entries in the list of 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. The first value in the list corresponds to the route origin, not the first destination. Must be used in conjunction with steps() = true.
    
    Returns:
    
    a list of strings representing names for each waypoint
  - waypointTargets
```
@SerializedName(value="waypoint_targets")
 @Nullable
public abstract 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. Must be used with steps() = true.
    
    Returns:
    
    a list of Points representing coordinate pairs for drop-off locations
    
    Since:
    
    4.3.0
  - waypointTargetsList
```
@Nullable
public java.util.List<com.mapbox.geojson.Point> waypointTargetsList()
```
    A list of points 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. Must be used with steps() = true.
    
    Returns:
    
    a list of Points representing coordinate pairs for drop-off locations
  - walkingOptions
```
@Nullable
public abstract WalkingOptions walkingOptions()
```
    To be used to specify settings for use with the walking profile.
    
    Returns:
    
    options to use for walking profile
    
    Since:
    
    4.8.0
  - typeAdapter
```
public static com.google.gson.TypeAdapter<RouteOptions> typeAdapter(com.google.gson.Gson gson)
```
    Gson type adapter for parsing Gson to this class.
    
    Parameters:
    
    gson - the built Gson object
    
    Returns:
    
    the type adapter for this class
    
    Since:
    
    3.0.0
  - fromJson
```
@NonNull
public static RouteOptions fromJson(java.lang.String json)
```
    Create a new instance of this class by passing in a formatted valid JSON String.
    
    Parameters:
    
    json - a formatted valid JSON string defining a RouteOptions
    
    Returns:
    
    a new instance of this class defined by the values passed inside this static factory method
    
    Since:
    
    3.4.0
  - toBuilder
```
@NonNull
public abstract RouteOptions.Builder toBuilder()
```
    Convert the current RouteOptions to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified RouteOptions.
    
    Returns:
    
    a RouteOptions.Builder with the same values set to match the ones defined in this RouteOptions

Class RouteOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject

Methods inherited from class java.lang.Object

Constructor Detail

RouteOptions

Method Detail

builder

baseUrl

user

profile

coordinates

alternatives

language

radiuses

radiusesList

bearings

bearingsList

continueStraight

roundaboutExits

geometries

overview

steps

annotations

annotationsList

exclude

voiceInstructions

bannerInstructions

voiceUnits

accessToken

requestUuid

approaches

approachesList

waypointIndices

waypointIndicesList

waypointNames

waypointNamesList

waypointTargets

waypointTargetsList

walkingOptions

typeAdapter

fromJson

toBuilder