public abstract static class RouteOptions.Builder
extends java.lang.Object
RouteOptions
.Constructor and Description |
---|
Builder() |
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 approaches the user originally made when the request was made.
|
public abstract RouteOptions.Builder baseUrl(@NonNull java.lang.String baseUrl)
baseUrl
- base URL used for original requestpublic abstract RouteOptions.Builder user(@NonNull java.lang.String user)
user
- string representing the user field in the calling urlpublic abstract RouteOptions.Builder profile(@NonNull java.lang.String profile)
profile
- One of the direction profiles defined in
DirectionsCriteria.DirectionsCriteria()
public abstract RouteOptions.Builder coordinates(@NonNull java.util.List<com.mapbox.geojson.Point> coordinates)
DirectionsWaypoint
s in
that these are the non-snapped coordinates.coordinates
- a list of Point
s which represent the route origin, destination,
and optionally, waypointspublic abstract RouteOptions.Builder alternatives(@Nullable java.lang.Boolean alternatives)
alternatives
- true if the request contained additional route request, otherwise falsepublic abstract RouteOptions.Builder language(java.lang.String language)
language
- a string with the language which was requested in the urlpublic abstract RouteOptions.Builder radiuses(java.lang.String radiuses)
radiuses
- radiuses values separated by commapublic abstract RouteOptions.Builder bearings(java.lang.String bearings)
bearings
- number values representing the bearings separated by commaspublic abstract RouteOptions.Builder continueStraight(java.lang.Boolean continueStraight)
continueStraight
- true if you'd like the user to continue straight from the starting
pointpublic abstract RouteOptions.Builder roundaboutExits(@Nullable java.lang.Boolean roundaboutExits)
roundaboutExits
- true if you'd like extra roundabout instructionspublic abstract RouteOptions.Builder geometries(java.lang.String geometries)
DirectionsCriteria.GEOMETRY_POLYLINE6
.geometries
- null if you'd like the default geometry, else one of the options found in
DirectionsCriteria.GeometriesCriteria
.public abstract RouteOptions.Builder overview(@Nullable java.lang.String overview)
overview
- null or one of the options found in
DirectionsCriteria.OverviewCriteria
public abstract RouteOptions.Builder steps(@Nullable java.lang.Boolean steps)
steps
- true if you'd like step information, false otherwisepublic abstract RouteOptions.Builder annotations(java.lang.String annotations)
annotations
- in string format and separated by commas if more than one annotation was
requestedpublic abstract RouteOptions.Builder voiceInstructions(java.lang.Boolean voiceInstructions)
voiceInstructions
- true if the original request included voice instructionspublic abstract RouteOptions.Builder bannerInstructions(java.lang.Boolean bannerInstructions)
bannerInstructions
- true if the original request included banner instructionspublic abstract RouteOptions.Builder voiceUnits(@Nullable java.lang.String voiceUnits)
voiceUnits
- string matching either imperial or metricpublic abstract RouteOptions.Builder accessToken(@NonNull java.lang.String accessToken)
accessToken
- a string containing a valid Mapbox access tokenpublic abstract RouteOptions.Builder requestUuid(@NonNull java.lang.String requestUuid)
requestUuid
- a string containing the request UUID@Nullable public abstract RouteOptions.Builder exclude(@NonNull java.lang.String exclude)
exclude
- a string matching one of the DirectionsCriteria
exclusions@Nullable public abstract RouteOptions.Builder approaches(java.lang.String approaches)
approaches
- unrestricted, curb or omitted (;)@Nullable public abstract RouteOptions.Builder waypointNames(@Nullable java.lang.String waypointNames)
waypointNames
- unrestricted, curb or omitted (;)public abstract RouteOptions build()
RouteOptions
object.RouteOptions
instance