RouteOptions (services 4.2.0-SNAPSHOT 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()` The same alternative setting which were used during the request that resulted in this root directions response.
`abstract java.lang.String`	`annotations()` The same annotations in String format which were used during the request that resulted in this root directions response.
`abstract java.lang.String`	`approaches()` Indicates from which side of the road to approach a waypoint.
`abstract java.lang.Boolean`	`bannerInstructions()` Whether or not the request had banner instructions set to true or not.
`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()` The same bearings which were used during the request that resulted in this root directions response.
`static RouteOptions.Builder`	`builder()` Build a new instance of this RouteOptions class optionally settling values.
`abstract java.lang.Boolean`	`continueStraight()` The same continueStraight setting which was used during the request that resulted in this root directions response.
`abstract java.util.List<com.mapbox.geojson.Point>`	`coordinates()` The coordinates used for the routes origin, destination, and optionally, waypoints.
`abstract java.lang.String`	`exclude()` The same exclusions the user originally made when the request was made.
`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()` Geometry type used to make the initial directions request.
`abstract java.lang.String`	`language()` The same language which was used during the request that resulted in this root directions response.
`abstract java.lang.String`	`overview()` Type of returned overview geometry that was used to make the initial directions request.
`abstract java.lang.String`	`profile()` The same profile which was used during the request that resulted in this root directions response.
`abstract java.lang.String`	`radiuses()` The same radiuses were used during the request that resulted in this root directions response.
`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()` This is set to true if you want to enable instructions while exiting roundabouts and rotaries.
`abstract java.lang.Boolean`	`steps()` Boolean value used to determine whether to return steps and turn-by-turn instructions in the initial directions request.
`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 or not the request had voice instructions set to true or not.
`abstract java.lang.String`	`voiceUnits()` Whether or not the units used inside the voice instruction's string are in imperial or metric.
`abstract java.lang.String`	`waypointNames()` Custom names for waypoints used for the arrival instruction in banners and voice instructions, each separated by ; .

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 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
    
    Since:
    
    3.0.0
  - coordinates
```
@NonNull
public abstract 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.
    
    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()
```
    The same alternative setting which were used during the request that resulted in this root directions response.
    
    Returns:
    
    boolean object representing the setting for alternatives
    
    Since:
    
    3.0.0
  - language
```
@Nullable
public abstract java.lang.String language()
```
    The same language which was used during the request that resulted in this root directions response.
    
    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 same radiuses were used during the request that resulted in this root directions response.
    
    Returns:
    
    a string representing the radiuses
    
    Since:
    
    3.0.0
  - bearings
```
@Nullable
public abstract java.lang.String bearings()
```
    The same bearings which were used during the request that resulted in this root directions response. Note that even though these are saved. it's a good idea to recalculate any bearings being used and use the newer values for the directions request.
    
    Returns:
    
    a string representing the bearings used in the original request
    
    Since:
    
    3.0.0
  - continueStraight
```
@SerializedName(value="continue_straight")
 @Nullable
public abstract java.lang.Boolean continueStraight()
```
    The same continueStraight setting which was used during the request that resulted in this root directions response.
    
    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()
```
    This is set to true if you want to enable instructions while exiting roundabouts and rotaries.
    
    Returns:
    
    a boolean value representing whether or not roundaboutExits was enabled or disabled during the initial route request
    
    Since:
    
    3.1.0
  - geometries
```
public abstract java.lang.String geometries()
```
    Geometry type used to make the initial directions request.
    
    Returns:
    
    String geometry type used to make the initial directions request.
    
    Since:
    
    3.1.0
  - overview
```
@Nullable
public abstract java.lang.String overview()
```
    Type of returned overview geometry that was used to make the initial directions request.
    
    Returns:
    
    null or one of the options found in DirectionsCriteria.OverviewCriteria
    
    Since:
    
    3.1.0
  - steps
```
@Nullable
public abstract java.lang.Boolean steps()
```
    Boolean value used to determine whether to return steps and turn-by-turn instructions in the initial directions request.
    
    Returns:
    
    true if you'd like step information, false otherwise
    
    Since:
    
    3.1.0
  - annotations
```
@Nullable
public abstract java.lang.String annotations()
```
    The same annotations in String format which were used during the request that resulted in this root directions response.
    
    Returns:
    
    a string containing any of the annotations that were used during the request
    
    Since:
    
    3.0.0
  - exclude
```
@Nullable
public abstract java.lang.String exclude()
```
    The same exclusions the user originally made when the request was made.
    
    Returns:
    
    a string matching one of the DirectionsCriteria exclusions
    
    Since:
    
    3.0.0
  - voiceInstructions
```
@SerializedName(value="voice_instructions")
 @Nullable
public abstract java.lang.Boolean voiceInstructions()
```
    Whether or not the request had voice instructions set to true or not.
    
    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 or not the request had banner instructions set to true or not.
    
    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()
```
    Whether or not the units used inside the voice instruction's string are in imperial or metric.
    
    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")
 @NonNull
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 unrestricted (default) or curb . If set to unrestricted , the route can approach waypoints from either side of the road. If set to 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.
    
    Returns:
    
    a string representing approaches for each waypoint
    
    Since:
    
    3.2.0
  - waypointNames
```
@SerializedName(value="waypoint_names")
 @Nullable
public abstract java.lang.String waypointNames()
```
    Custom names for waypoints used for the arrival instruction in banners and voice instructions, each separated by ; . Values can be any string and 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 and show its position with the ; separator.
    
    Returns:
    
    a string representing names for each waypoint
    
    Since:
    
    3.3.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
```
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

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

bearings

continueStraight

roundaboutExits

geometries

overview

steps

annotations

exclude

voiceInstructions

bannerInstructions

voiceUnits

accessToken

requestUuid

approaches

waypointNames

typeAdapter

fromJson