Skip navigation links
A B C D E F G I J L M N O P R S T U V W 

A

abbreviation() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
The abbreviated form of text.
abbreviation(String) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
The abbreviated form of text.
abbreviationPriority() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
An integer indicating the order in which the abbreviation abbr should be used in place of text.
abbreviationPriority(Integer) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
An integer indicating the order in which the abbreviation abbr should be used in place of text.
accessToken() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A valid Mapbox access token used to making the request.
accessToken(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
A valid Mapbox access token used to making the request.
active() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
A boolean telling you if that lane can be used to complete the upcoming maneuver.
active(Boolean) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
A boolean telling you if that lane can be used to complete the upcoming maneuver.
alleyBias() - Method in class com.mapbox.api.directions.v5.WalkingOptions
A bias which determines whether the route should prefer or avoid the use of alleys.
alleyBias(Double) - Method in class com.mapbox.api.directions.v5.WalkingOptions.Builder
A bias which determines whether the route should prefer or avoid the use of alleys.
alternatives() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Whether to try to return alternative routes (true) or not (false, default).
alternatives(Boolean) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to try to return alternative routes (true) or not (false, default).
annotation() - Method in class com.mapbox.api.directions.v5.models.RouteLeg
A LegAnnotation that contains additional details about each line segment along the route geometry.
annotation(LegAnnotation) - Method in class com.mapbox.api.directions.v5.models.RouteLeg.Builder
A LegAnnotation that contains additional details about each line segment along the route geometry.
ANNOTATION_CONGESTION - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The congestion, provided as a String, between each pair of coordinates.
ANNOTATION_DISTANCE - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The distance, in meters, between each pair of coordinates.
ANNOTATION_DURATION - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The duration, in seconds, between each pair of coordinates.
ANNOTATION_MAXSPEED - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The posted speed limit, between each pair of coordinates.
ANNOTATION_SPEED - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The speed, in km/h, between each pair of coordinates.
annotations() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A comma-separated list of annotations.
annotations(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to return additional metadata along the route.
annotationsList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A list of annotations.
annotationsList(List<String>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to return additional metadata along the route.
announcement() - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions
Provides the instruction string which was build on the server-side and can sometimes concatenate instructions together if maneuver instructions are too close to each other.
announcement(String) - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions.Builder
Provides the instruction string which was build on the server-side and can sometimes concatenate instructions together if maneuver instructions are too close to each other.
APPROACH_CURB - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
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.
APPROACH_UNRESTRICTED - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The routes can approach waypoints from either side of the road.
approaches() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Indicates from which side of the road to approach a waypoint.
approaches(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Indicates from which side of the road to approach a waypoint.
approachesList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Indicates from which side of the road to approach a waypoint.
approachesList(List<String>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Indicates from which side of the road to approach a waypoint.
ARRIVE - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Indicates arrival to a destination of a leg.

B

BannerComponents - Class in com.mapbox.api.directions.v5.models
A part of the BannerText which includes a snippet of the full banner text instruction.
BannerComponents() - Constructor for class com.mapbox.api.directions.v5.models.BannerComponents
 
BannerComponents.BannerComponentsType - Annotation Type in com.mapbox.api.directions.v5.models
Banner component types.
BannerComponents.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the BannerComponents.
BannerInstructions - Class in com.mapbox.api.directions.v5.models
Visual instruction information related to a particular LegStep useful for making UI elements inside your application such as banners.
BannerInstructions() - Constructor for class com.mapbox.api.directions.v5.models.BannerInstructions
 
bannerInstructions() - Method in class com.mapbox.api.directions.v5.models.LegStep
If in your request you set MapboxDirections.Builder#bannerInstructions() to true, you'll receive a list of BannerInstructions which encompasses all information necessary for creating a visual cue about a given LegStep.
bannerInstructions(List<BannerInstructions>) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
If in your request you set MapboxDirections.Builder#bannerInstructions() to true, you'll receive a list of BannerInstructions which encompasses all information necessary for creating a visual cue about a given LegStep.
bannerInstructions() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Whether to return banner objects associated with the route steps (true) or not (false, default).
bannerInstructions(Boolean) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to return banner objects associated with the route steps (true) or not (false, default).
BannerInstructions.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the BannerInstructions.
BannerText - Class in com.mapbox.api.directions.v5.models
Includes both plain text information that can be visualized inside your navigation application along with the text string broken down into BannerComponents which may or may not include a image url.
BannerText() - Constructor for class com.mapbox.api.directions.v5.models.BannerText
 
BannerText.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the BannerText.
BannerView - Class in com.mapbox.api.directions.v5.models
Includes both plain text information that can be visualized inside your navigation application along with the text string broken down into BannerComponents which may or may not include a image url.
BannerView() - Constructor for class com.mapbox.api.directions.v5.models.BannerView
 
BannerView.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the BannerView.
baseUrl() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The same base URL which was used during the request that resulted in this root directions response.
baseUrl(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The base URL that was used during the request time and resulted in this responses result.
bearingAfter() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right after the maneuver.
bearingAfter(Double) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right after the maneuver.
bearingBefore() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right before the maneuver.
bearingBefore(Double) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right before the maneuver.
bearings() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Influences the direction in which a route starts from a waypoint.
bearings(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Influences the direction in which a route starts from a waypoint.
bearings() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
An integer list of bearing values available at the step intersection.
bearings(List<Integer>) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
An integer array of bearing values available at the step intersection.
bearingsList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Influences the direction in which a route starts from a waypoint.
bearingsList(List<List<Double>>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Influences the direction in which a route starts from a waypoint.
build() - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
Build a new BannerComponents object.
build() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
Build a new BannerInstructions object.
build() - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
Build a new BannerText object.
build() - Method in class com.mapbox.api.directions.v5.models.BannerView.Builder
Build a new BannerView object.
build() - Method in class com.mapbox.api.directions.v5.models.DirectionsError.Builder
Build a new DirectionsError object.
build() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
Build a new DirectionsResponse object.
build() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
Build a new DirectionsRoute object.
build() - Method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint.Builder
Build a new DirectionsWaypoint object.
build() - Method in class com.mapbox.api.directions.v5.models.IntersectionLanes.Builder
Build a new IntersectionLanes object.
build() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
Build a new LegAnnotation object.
build() - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
Build a new LegStep object.
build() - Method in class com.mapbox.api.directions.v5.models.MaxSpeed.Builder
Build a new MaxSpeed object.
build() - Method in class com.mapbox.api.directions.v5.models.RouteLeg.Builder
Build a new RouteLeg object.
build() - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Builds a new instance of the RouteOptions object.
build() - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
Build a new StepIntersection object.
build() - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
Build a new StepManeuver object.
build() - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions.Builder
This uses the provided parameters set using the VoiceInstructions.Builder and creates a new instance of VoiceInstructions.
build() - Method in class com.mapbox.api.directions.v5.WalkingOptions.Builder
Builds a WalkingOptions object with specified configurations.
builder() - Static method in class com.mapbox.api.directions.v5.models.BannerComponents
Create a new instance of this class by using the BannerComponents.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.BannerComponents.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.BannerInstructions
Create a new instance of this class by using the BannerInstructions.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.BannerText
Create a new instance of this class by using the BannerText.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.BannerText.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.BannerView
Create a new instance of this class by using the BannerView.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.BannerView.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.DirectionsError
Create a new instance of this class by using the DirectionsError.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsError.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.DirectionsResponse
Create a new instance of this class by using the DirectionsResponse.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.DirectionsRoute
Create a new instance of this class by using the DirectionsRoute.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint
Create a new instance of this class by using the DirectionsWaypoint.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsWaypoint.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.IntersectionLanes
Create a new instance of this class by using the IntersectionLanes.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.IntersectionLanes.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.LegAnnotation
Create a new instance of this class by using the LegAnnotation.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.LegStep
Create a new instance of this class by using the LegStep.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.LegStep.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.MaxSpeed
Create a new instance of this class by using the MaxSpeed.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.MaxSpeed.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.RouteLeg
Create a new instance of this class by using the RouteLeg.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.RouteLeg.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.RouteOptions
Build a new instance of this RouteOptions class optionally settling values.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.RouteOptions.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.StepIntersection
Create a new instance of this class by using the StepIntersection.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.StepIntersection.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.StepManeuver
Create a new instance of this class by using the StepManeuver.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.StepManeuver.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.models.VoiceInstructions
Create a new instance of this class by using the VoiceInstructions.Builder class.
Builder() - Constructor for class com.mapbox.api.directions.v5.models.VoiceInstructions.Builder
 
builder() - Static method in class com.mapbox.api.directions.v5.WalkingOptions
Build a new WalkingOptions object with no defaults.
Builder() - Constructor for class com.mapbox.api.directions.v5.WalkingOptions.Builder
 

C

classes(List<String>) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
A list of strings signifying the classes of the road exiting the intersection.
classes() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
A list of strings signifying the classes of the road exiting the intersection.
code(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsError.Builder
String indicating the state of the response.
code() - Method in class com.mapbox.api.directions.v5.models.DirectionsError
String indicating the state of the response.
code(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
String indicating the state of the response.
code() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse
String indicating the state of the response.
com.mapbox.api.directions.v5 - package com.mapbox.api.directions.v5
Contains classes for accessing the Mapbox Directions API.
com.mapbox.api.directions.v5.models - package com.mapbox.api.directions.v5.models
Contains models mapping to Mapbox Directions API.
com.mapbox.api.directions.v5.utils - package com.mapbox.api.directions.v5.utils
Contains classes with utilities useful for model classes.
compareTo(BannerComponents) - Method in class com.mapbox.api.directions.v5.models.BannerComponents
Allows ability to sort/compare by abbreviation priority.
components(List<BannerComponents>) - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
A part or element of the BannerInstructions.
components() - Method in class com.mapbox.api.directions.v5.models.BannerText
A part or element of the BannerInstructions.
components(List<BannerComponents>) - Method in class com.mapbox.api.directions.v5.models.BannerView.Builder
A part or element of the BannerInstructions.
components() - Method in class com.mapbox.api.directions.v5.models.BannerView
A part or element of the BannerInstructions.
congestion(List<String>) - Method in class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
The congestion between each pair of coordinates.
congestion() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation
The congestion between each pair of coordinates.
CONTINUE - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Continue on a street after a turn.
continueStraight(Boolean) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Sets the allowed direction of travel when departing intermediate waypoints.
continueStraight() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The allowed direction of travel when departing intermediate waypoints.
coordinates(List<Point>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
A list of Points to visit in order.
coordinates() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A list of Points to visit in order.
create() - Static method in class com.mapbox.api.directions.v5.DirectionsAdapterFactory
Creates a TypeAdapter that AutoValues uses to generate specific type adapters when needed inside the direction package classes.
create() - Static method in class com.mapbox.api.directions.v5.WalkingOptionsAdapterFactory
Create a new instance of this WalkingOptions type adapter factory.

D

degrees(Double) - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
The degrees at which you will be exiting a roundabout, assuming `180` indicates going straight through the roundabout.
degrees() - Method in class com.mapbox.api.directions.v5.models.BannerText
The degrees at which you will be exiting a roundabout, assuming `180` indicates going straight through the roundabout.
DELIMITER - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
This is text that can be dropped, and should be dropped if you are rendering icons.
DEPART - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Indicates departure from a leg.
DESTINATION_ANY - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Returned route ends at any of the provided coordinate in the list.
DESTINATION_LAST - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Returned route ends at the last provided coordinate in the list.
destinations(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
String with the destinations of the way along which the travel proceeds.
destinations() - Method in class com.mapbox.api.directions.v5.models.LegStep
String with the destinations of the way along which the travel proceeds.
directions(List<String>) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
A List of directions indicating which way you can go from a lane (left, right, or straight).
directions() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
A List of directions indicating which way you can go from a lane (left, right, or straight).
DirectionsAdapterFactory - Class in com.mapbox.api.directions.v5
Required so that AutoValue can generate specific type adapters when needed inside the direction packages.
DirectionsAdapterFactory() - Constructor for class com.mapbox.api.directions.v5.DirectionsAdapterFactory
 
DirectionsCriteria - Class in com.mapbox.api.directions.v5
Constants and properties used to customize the directions request.
DirectionsCriteria.AnnotationCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the various direction annotations.
DirectionsCriteria.ApproachesCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the approaches parameter in the MapMatching and Directions API.
DirectionsCriteria.DestinationCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the destination parameter in the Optimization API.
DirectionsCriteria.ExcludeCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the various direction exclusions.
DirectionsCriteria.GeometriesCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the various direction geometries.
DirectionsCriteria.OverviewCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the various direction overviews.
DirectionsCriteria.ProfileCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the various direction profiles.
DirectionsCriteria.SourceCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the source parameter in the Optimization API.
DirectionsCriteria.VoiceUnitCriteria - Annotation Type in com.mapbox.api.directions.v5
Retention policy for the various units of measurements.
DirectionsError - Class in com.mapbox.api.directions.v5.models
If an InvalidInput error is thrown, this class can be used to get both the code and the message which holds an explanation of the invalid input.
DirectionsError() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsError
 
DirectionsError.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the DirectionsError.
DirectionsJsonObject - Class in com.mapbox.api.directions.v5.models
Provideds a base class for Directions model classes.
DirectionsJsonObject() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsJsonObject
 
DirectionsResponse - Class in com.mapbox.api.directions.v5.models
This is the root Mapbox Directions API response.
DirectionsResponse() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsResponse
 
DirectionsResponse.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the DirectionsResponse.
DirectionsRoute - Class in com.mapbox.api.directions.v5.models
Detailed information about an individual route such as the duration, distance and geometry.
DirectionsRoute() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsRoute
 
DirectionsRoute.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the DirectionsRoute.
DirectionsWaypoint - Class in com.mapbox.api.directions.v5.models
An input coordinate snapped to the roads network.
DirectionsWaypoint() - Constructor for class com.mapbox.api.directions.v5.models.DirectionsWaypoint
 
DirectionsWaypoint.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the DirectionsWaypoint.
distance(Double) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
The distance traveled from origin to destination.
distance() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
The distance traveled from origin to destination.
distance(List<Double>) - Method in class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
The distance, in meters, between each pair of coordinates.
distance() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation
The distance, in meters, between each pair of coordinates.
distance(double) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
The distance traveled from the maneuver to the next LegStep.
distance() - Method in class com.mapbox.api.directions.v5.models.LegStep
The distance traveled from the maneuver to the next LegStep.
distance(Double) - Method in class com.mapbox.api.directions.v5.models.RouteLeg.Builder
The distance traveled from one waypoint to another.
distance() - Method in class com.mapbox.api.directions.v5.models.RouteLeg
The distance traveled from one waypoint to another.
distanceAlongGeometry(double) - Method in class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
Distance in meters from the beginning of the step at which the visual instruction should be visible.
distanceAlongGeometry() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions
Distance in meters from the beginning of the step at which the visual instruction should be visible.
distanceAlongGeometry(Double) - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions.Builder
Returns the missing piece in which is needed to announce instructions at accurate times.
distanceAlongGeometry() - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions
This provides the missing piece in which is needed to announce instructions at accurate times.
drivingSide(String) - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
A string representing which side the of the street people drive on in that location.
drivingSide() - Method in class com.mapbox.api.directions.v5.models.BannerText
A string representing which side the of the street people drive on in that location.
drivingSide(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
The legal driving side at the location for this step.
drivingSide() - Method in class com.mapbox.api.directions.v5.models.LegStep
The legal driving side at the location for this step.
duration(Double) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
The estimated travel time from origin to destination.
duration() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
The estimated travel time from origin to destination.
duration(List<Double>) - Method in class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
The speed, in meters per second, between each pair of coordinates.
duration() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation
The speed, in meters per second, between each pair of coordinates.
duration(double) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
The estimated travel time from the maneuver to the next LegStep.
duration() - Method in class com.mapbox.api.directions.v5.models.LegStep
The estimated travel time from the maneuver to the next LegStep.
duration(Double) - Method in class com.mapbox.api.directions.v5.models.RouteLeg.Builder
The estimated travel time from one waypoint to another.
duration() - Method in class com.mapbox.api.directions.v5.models.RouteLeg
The estimated travel time from one waypoint to another.

E

END_OF_ROAD - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Road ends in a T intersection.
entry(List<Boolean>) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
A list of entry flags, corresponding in a 1:1 relationship to the bearings.
entry() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
A list of entry flags, corresponding in a 1:1 relationship to the bearings.
exclude(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Exclude certain road types from routing.
exclude() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Exclude certain road types from routing.
EXCLUDE_FERRY - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Exclude all ferries along the returned directions route.
EXCLUDE_MOTORWAY - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Exclude all motorways along the returned directions route.
EXCLUDE_RESTRICTED - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Exclude all roads with access restrictions along the returned directions route.
EXCLUDE_TOLL - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Exclude all tolls along the returned directions route.
EXCLUDE_TUNNEL - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Exclude all tunnels along the returned directions route.
EXIT - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
Provides the the word for exit in the local language.
exit(Integer) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
An optional integer indicating number of the exit to take.
exit() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
An optional integer indicating number of the exit to take.
EXIT_NUMBER - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
Indicates the exit number for the maneuver.
EXIT_ROTARY - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Indicates the exit maneuver from a rotary.
EXIT_ROUNDABOUT - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Indicates the exit maneuver from a roundabout.
exits(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
String with the exit numbers or names of the way.
exits() - Method in class com.mapbox.api.directions.v5.models.LegStep
String with the exit numbers or names of the way.

F

FORK - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Take the left or right side of a fork.
formatApproaches(List<String>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Converts String list with approaches values to a string ready for API consumption.
formatBearings(List<List<Double>>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Formats the bearing variables from the raw values to a string which can than be used for the request URL.
formatCoordinate(double) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Useful to remove any trailing zeros and prevent a coordinate being over 7 significant figures.
formatCoordinates(List<Point>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Converts a list of Points to String.
formatDistributions(List<Integer[]>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Converts the list of integer arrays to a string ready for API consumption.
formatPointsList(List<Point>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Converts array of Points with waypoint_targets values to a string ready for API consumption.
formatRadiuses(List<Double>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Used in various APIs to format the user provided radiuses to a String matching the APIs format.
FormatUtils - Class in com.mapbox.api.directions.v5.utils
Methods to convert models to Strings.
FormatUtils() - Constructor for class com.mapbox.api.directions.v5.utils.FormatUtils
 
formatWaypointNames(List<String>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Converts String list with waypoint_names values to a string ready for API consumption.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.BannerComponents
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.BannerInstructions
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.BannerText
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.BannerView
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.DirectionsResponse
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.DirectionsRoute
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.IntersectionLanes
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.LegAnnotation
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.LegStep
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.MaxSpeed
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.RouteLeg
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.RouteOptions
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.StepIntersection
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.StepManeuver
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.models.VoiceInstructions
Create a new instance of this class by passing in a formatted valid JSON String.
fromJson(String) - Static method in class com.mapbox.api.directions.v5.WalkingOptions
Create a new instance of this class by passing in a formatted valid JSON String.

G

geometries(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The format of the returned geometry.
geometries() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The format of the returned geometry.
geometry(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
Gives the geometry of the route.
geometry() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
Gives the geometry of the route.
geometry(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
Gives the geometry of the leg step.
geometry() - Method in class com.mapbox.api.directions.v5.models.LegStep
Gives the geometry of the leg step.
GEOMETRY_POLYLINE - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Format to return route geometry will be an encoded polyline.
GEOMETRY_POLYLINE6 - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Format to return route geometry will be an encoded polyline with precision 6.
GUIDANCE_VIEW - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
This view gives guidance through junctions and is used to complete maneuvers.

I

ICON - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
This is text that can be replaced by an imageBaseURL icon.
imageBaseUrl(String) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
In some cases when the LegStep is a highway or major roadway, there might be a shield icon that's included to better identify to your user to roadway.
imageBaseUrl() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
In some cases when the LegStep is a highway or major roadway, there might be a shield icon that's included to better identify to your user to roadway.
imageUrl(String) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
In some cases when the StepManeuver will be difficult to navigate, an image can describe how to proceed.
imageUrl() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
In some cases when the StepManeuver will be difficult to navigate, an image can describe how to proceed.
IMPERIAL - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Change the units to imperial for voice and visual information.
in(Integer) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
Index into bearings/entry array.
in() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
Index into bearings/entry array.
indications(List<String>) - Method in class com.mapbox.api.directions.v5.models.IntersectionLanes.Builder
list that can be made up of multiple signs such as left, right, etc.
indications() - Method in class com.mapbox.api.directions.v5.models.IntersectionLanes
Array that can be made up of multiple signs such as left, right, etc.
instruction(String) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
A human-readable instruction of how to execute the returned maneuver.
instruction() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
A human-readable instruction of how to execute the returned maneuver.
IntersectionLanes - Class in com.mapbox.api.directions.v5.models
Object representing lanes in an intersection.
IntersectionLanes() - Constructor for class com.mapbox.api.directions.v5.models.IntersectionLanes
 
IntersectionLanes.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the IntersectionLanes.
intersections(List<StepIntersection>) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
Provide a list of all the intersections connected to the current way the user is traveling along.
intersections() - Method in class com.mapbox.api.directions.v5.models.LegStep
Provides a list of all the intersections connected to the current way the user is traveling along.

J

join(CharSequence, List<?>) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Returns a string containing the tokens joined by delimiters.
join(CharSequence, List<?>, boolean) - Static method in class com.mapbox.api.directions.v5.utils.FormatUtils
Returns a string containing the tokens joined by delimiters.

L

LANE - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
Indicates which lanes can be used to complete the maneuver.
lanes(List<IntersectionLanes>) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
Array of lane objects that represent the available turn lanes at the intersection.
lanes() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
Array of lane objects that represent the available turn lanes at the intersection.
language(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The language of returned turn-by-turn text instructions.
language() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The language of returned turn-by-turn text instructions.
LegAnnotation - Class in com.mapbox.api.directions.v5.models
An annotations object that contains additional details about each line segment along the route geometry.
LegAnnotation() - Constructor for class com.mapbox.api.directions.v5.models.LegAnnotation
 
LegAnnotation.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the LegAnnotation.
legs(List<RouteLeg>) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
A Leg is a route between only two waypoints.
legs() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
A Leg is a route between only two waypoints.
LegStep - Class in com.mapbox.api.directions.v5.models
Includes one StepManeuver object and travel to the following LegStep.
LegStep() - Constructor for class com.mapbox.api.directions.v5.models.LegStep
 
LegStep.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the LegStep.
location() - Method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint
A Point representing this waypoint location.
location() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
A Point representing this intersection location.
location() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
A Point representing this intersection location.

M

maneuver(StepManeuver) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
A StepManeuver object that typically represents the first coordinate making up the LegStep.geometry().
maneuver() - Method in class com.mapbox.api.directions.v5.models.LegStep
A StepManeuver object that typically represents the first coordinate making up the LegStep.geometry().
maxspeed(List<MaxSpeed>) - Method in class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
The posted speed limit, between each pair of coordinates.
maxspeed() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation
The posted speed limit, between each pair of coordinates.
MaxSpeed - Class in com.mapbox.api.directions.v5.models
Object representing max speeds along a route.
MaxSpeed() - Constructor for class com.mapbox.api.directions.v5.models.MaxSpeed
 
MaxSpeed.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the MaxSpeed.
MERGE - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Merge onto a street.
message(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsError.Builder
Provides a short message with the explanation of the invalid input.
message() - Method in class com.mapbox.api.directions.v5.models.DirectionsError
Provides a short message with the explanation of the invalid input.
message(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
Optionally shows up in a directions response if an error or something unexpected occurred.
message() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse
Optionally shows up in a directions response if an error or something unexpected occurred.
METRIC - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Change the units to metric for voice and visual information.
mode(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
Indicates the mode of transportation in the step.
mode() - Method in class com.mapbox.api.directions.v5.models.LegStep
indicates the mode of transportation in the step.
modifier(String) - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
This indicates the mode of the maneuver.
modifier() - Method in class com.mapbox.api.directions.v5.models.BannerText
This indicates the mode of the maneuver.
modifier(String) - Method in class com.mapbox.api.directions.v5.models.BannerView.Builder
This indicates the mode of the maneuver.
modifier() - Method in class com.mapbox.api.directions.v5.models.BannerView
This indicates the mode of the maneuver.
modifier(String) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
This indicates the mode of the maneuver.
modifier() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
This indicates the mode of the maneuver.

N

name(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint.Builder
Provides the way name which the waypoint's coordinate is snapped to.
name() - Method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint
Provides the way name which the waypoint's coordinate is snapped to.
name(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
String with the name of the way along which the travel proceeds.
name() - Method in class com.mapbox.api.directions.v5.models.LegStep
String with the name of the way along which the travel proceeds.
NEW_NAME - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
The road name changes (after a mandatory turn).
none(Boolean) - Method in class com.mapbox.api.directions.v5.models.MaxSpeed.Builder
Boolean is `true` if the speed limit is unlimited, otherwise null.
none() - Method in class com.mapbox.api.directions.v5.models.MaxSpeed
Boolean is `true` if the speed limit is unlimited, otherwise null.
NOTIFICATION - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Indicates a change of driving conditions, for example changing the mode from driving to ferry.

O

OFF_RAMP - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Take a ramp to exit a highway.
ON_RAMP - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Take a ramp to enter a highway.
out(Integer) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
Index out of the bearings/entry array.
out() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
Index out of the bearings/entry array.
overview(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Displays the requested type of overview geometry.
overview() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Displays the requested type of overview geometry.
OVERVIEW_FALSE - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
No overview geometry.
OVERVIEW_FULL - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
The most detailed geometry available.
OVERVIEW_SIMPLIFIED - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
A simplified version of the DirectionsCriteria.OVERVIEW_FULL geometry.

P

parseToDoubles(String) - Static method in class com.mapbox.api.directions.v5.utils.ParseUtils
Parse a String to a list of Points.
parseToIntegers(String) - Static method in class com.mapbox.api.directions.v5.utils.ParseUtils
Parse a String to a list of Integers.
parseToListOfListOfDoubles(String) - Static method in class com.mapbox.api.directions.v5.utils.ParseUtils
Parse a String to a list of list of Doubles.
parseToPoints(String) - Static method in class com.mapbox.api.directions.v5.utils.ParseUtils
Parse a String to a list of Points.
parseToStrings(String) - Static method in class com.mapbox.api.directions.v5.utils.ParseUtils
Parse a String to a list of Strings using ";" as a separator.
parseToStrings(String, String) - Static method in class com.mapbox.api.directions.v5.utils.ParseUtils
Parse a String to a list of Strings.
ParseUtils - Class in com.mapbox.api.directions.v5.utils
Methods to convert Strings to Lists of objects.
ParseUtils() - Constructor for class com.mapbox.api.directions.v5.utils.ParseUtils
 
primary(BannerText) - Method in class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
Main visual information about the LegStep.
primary() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions
A plain text representation stored inside a BannerText object.
profile(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The routing profile to use.
profile() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The routing profile to use.
PROFILE_CYCLING - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
For bicycle routing.
PROFILE_DEFAULT_USER - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Mapbox default username.
PROFILE_DRIVING - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
For car and motorcycle routing.
PROFILE_DRIVING_TRAFFIC - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
For car and motorcycle routing.
PROFILE_WALKING - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
For pedestrian and hiking routing.
pronunciation(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
The pronunciation hint of the way name.
pronunciation() - Method in class com.mapbox.api.directions.v5.models.LegStep
The pronunciation hint of the way name.

R

radiuses(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The maximum distance a coordinate can be moved to snap to the road network in meters.
radiuses() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The maximum distance a coordinate can be moved to snap to the road network in meters.
radiusesList(List<Double>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The maximum distance a coordinate can be moved to snap to the road network in meters.
radiusesList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The maximum distance a coordinate can be moved to snap to the road network in meters.
rawLocation(double[]) - Method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint.Builder
The rawLocation as a double array.
rawLocation(double[]) - Method in class com.mapbox.api.directions.v5.models.StepIntersection.Builder
The rawLocation as a double array.
rawLocation() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
A Point representing this intersection location.
rawLocation(double[]) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
The rawLocation as a double array.
rawLocation() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
A Point representing this intersection location.
ref(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
String with reference number or code of the way along which the travel proceeds.
ref() - Method in class com.mapbox.api.directions.v5.models.LegStep
Any road designations associated with the road or path leading from this step's maneuver to the next step's maneuver.
requestUuid(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
requestUuid() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
ROTARY - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
A traffic circle.
rotaryName(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
An optional string indicating the name of the rotary.
rotaryName() - Method in class com.mapbox.api.directions.v5.models.LegStep
An optional string indicating the name of the rotary.
rotaryPronunciation(String) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
An optional string indicating the pronunciation of the name of the rotary.
rotaryPronunciation() - Method in class com.mapbox.api.directions.v5.models.LegStep
An optional string indicating the pronunciation of the name of the rotary.
ROUNDABOUT - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
Traverse roundabout.
ROUNDABOUT_TURN - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
A small roundabout that is treated as an intersection.
roundaboutExits(Boolean) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to emit instructions at roundabout exits (true) or not (false, default).
roundaboutExits() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Whether to emit instructions at roundabout exits (true) or not (false, default).
routeIndex() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
The index of this route in the original network response.
RouteLeg - Class in com.mapbox.api.directions.v5.models
A route between only two DirectionsWaypoint.
RouteLeg() - Constructor for class com.mapbox.api.directions.v5.models.RouteLeg
 
RouteLeg.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the RouteLeg.
routeOptions(RouteOptions) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
Holds onto the parameter information used when making the directions request.
routeOptions() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
Holds onto the parameter information used when making the directions request.
RouteOptions - Class in com.mapbox.api.directions.v5.models
Provides information connected to your request that help when a new directions request is needing using the identical parameters as the original request.
RouteOptions() - Constructor for class com.mapbox.api.directions.v5.models.RouteOptions
 
RouteOptions.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the RouteOptions.
routes(List<DirectionsRoute>) - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
List containing all the different route options.
routes() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse
List containing all the different route options.

S

secondary(BannerText) - Method in class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
Ancillary visual information about the LegStep.
secondary() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions
Ancillary visual information about the LegStep.
SOURCE_ANY - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Returned route starts at any of the provided coordinate in the list.
SOURCE_FIRST - Static variable in class com.mapbox.api.directions.v5.DirectionsCriteria
Returned route starts at the first provided coordinate in the list.
speed(List<Double>) - Method in class com.mapbox.api.directions.v5.models.LegAnnotation.Builder
The speed, in meters per second, between each pair of coordinates.
speed() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation
The speed, in meters per second, between each pair of coordinates.
speed(Integer) - Method in class com.mapbox.api.directions.v5.models.MaxSpeed.Builder
Number indicating the posted speed limit.
speed() - Method in class com.mapbox.api.directions.v5.models.MaxSpeed
Number indicating the posted speed limit.
ssmlAnnouncement(String) - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions.Builder
Get the same instruction string you'd get from VoiceInstructions.announcement() but this one includes Speech Synthesis Markup Language which helps voice synthesiser read information more humanely.
ssmlAnnouncement() - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions
Get the same instruction string you'd get from VoiceInstructions.announcement() but this one includes Speech Synthesis Markup Language which helps voice synthesiser read information more humanely.
StepIntersection - Class in com.mapbox.api.directions.v5.models
Object representing an intersection along the step.
StepIntersection() - Constructor for class com.mapbox.api.directions.v5.models.StepIntersection
 
StepIntersection.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the StepIntersection.
StepManeuver - Class in com.mapbox.api.directions.v5.models
Gives maneuver information about one LegStep.
StepManeuver() - Constructor for class com.mapbox.api.directions.v5.models.StepManeuver
 
StepManeuver.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the StepManeuver.
StepManeuver.StepManeuverType - Annotation Type in com.mapbox.api.directions.v5.models
Maneuver types.
steps(List<LegStep>) - Method in class com.mapbox.api.directions.v5.models.RouteLeg.Builder
Gives a List including all the steps to get from one waypoint to another.
steps() - Method in class com.mapbox.api.directions.v5.models.RouteLeg
Gives a List including all the steps to get from one waypoint to another.
steps(Boolean) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to return steps and turn-by-turn instructions (true) or not (false, default).
steps() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Whether to return steps and turn-by-turn instructions (true) or not (false, default).
sub(BannerText) - Method in class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
Additional information that is included if we feel the driver needs a heads up about something.
sub() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions
Additional information that is included if we feel the driver needs a heads up about something.
summary(String) - Method in class com.mapbox.api.directions.v5.models.RouteLeg.Builder
A short human-readable summary of major roads traversed.
summary() - Method in class com.mapbox.api.directions.v5.models.RouteLeg
A short human-readable summary of major roads traversed.

T

text(String) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
A snippet of the full BannerText.text() which can be used for visually altering parts of the full string.
TEXT - Static variable in class com.mapbox.api.directions.v5.models.BannerComponents
Default.
text() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
A snippet of the full BannerText.text() which can be used for visually altering parts of the full string.
text(String) - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
Plain text with all the BannerComponents text combined.
text() - Method in class com.mapbox.api.directions.v5.models.BannerText
Plain text with all the BannerComponents text combined.
text(String) - Method in class com.mapbox.api.directions.v5.models.BannerView.Builder
Plain text with all the BannerComponents text combined.
text() - Method in class com.mapbox.api.directions.v5.models.BannerView
Plain text with all the BannerComponents text combined.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
Convert the current BannerComponents to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions
Convert the current BannerInstructions to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.BannerText
Convert the current BannerText to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.BannerView
Convert the current BannerView to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.DirectionsError
Convert the current DirectionsError to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse
Convert the current DirectionsResponse to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
Convert the current DirectionsRoute to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint
Convert the current DirectionsWaypoint to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.IntersectionLanes
Convert the current IntersectionLanes to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.LegAnnotation
Convert the current LegAnnotation to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.LegStep
Convert the current LegStep to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.MaxSpeed
Convert the current MaxSpeed to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.RouteLeg
Convert the current RouteLeg to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Convert the current RouteOptions to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.StepIntersection
Convert the current StepIntersection to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
Convert the current StepManeuver to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.models.VoiceInstructions
Convert the current VoiceInstructions to its builder holding the currently assigned values.
toBuilder() - Method in class com.mapbox.api.directions.v5.WalkingOptions
Convert the current WalkingOptions to its builder holding the currently assigned values.
toJson() - Method in class com.mapbox.api.directions.v5.models.DirectionsJsonObject
This takes the currently defined values found inside this instance and converts it to a json string.
toJson() - Method in class com.mapbox.api.directions.v5.WalkingOptions
This takes the currently defined values found inside this instance and converts it to a json string.
TURN - Static variable in class com.mapbox.api.directions.v5.models.StepManeuver
A basic turn in the direction of the modifier.
type(String) - Method in class com.mapbox.api.directions.v5.models.BannerComponents.Builder
String giving you more context about the component which may help in visual markup/display choices.
type() - Method in class com.mapbox.api.directions.v5.models.BannerComponents
String giving you more context about the component which may help in visual markup/display choices.
type(String) - Method in class com.mapbox.api.directions.v5.models.BannerText.Builder
This indicates the type of maneuver.
type() - Method in class com.mapbox.api.directions.v5.models.BannerText
This indicates the type of maneuver.
type(String) - Method in class com.mapbox.api.directions.v5.models.BannerView.Builder
This indicates the type of maneuver.
type() - Method in class com.mapbox.api.directions.v5.models.BannerView
This indicates the type of maneuver.
type(String) - Method in class com.mapbox.api.directions.v5.models.StepManeuver.Builder
This indicates the type of maneuver.
type() - Method in class com.mapbox.api.directions.v5.models.StepManeuver
This indicates the type of maneuver.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.BannerComponents
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.BannerInstructions
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.BannerText
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.BannerView
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.DirectionsError
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.DirectionsResponse
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.DirectionsRoute
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.DirectionsWaypoint
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.IntersectionLanes
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.LegAnnotation
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.LegStep
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.MaxSpeed
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.RouteLeg
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.RouteOptions
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.StepIntersection
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.StepManeuver
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.models.VoiceInstructions
Gson type adapter for parsing Gson to this class.
typeAdapter(Gson) - Static method in class com.mapbox.api.directions.v5.WalkingOptions
Gson type adapter for parsing Gson to this class.

U

unit(String) - Method in class com.mapbox.api.directions.v5.models.MaxSpeed.Builder
String indicating the unit of speed, either as `km/h` or `mph`.
unit() - Method in class com.mapbox.api.directions.v5.models.MaxSpeed
String indicating the unit of speed, either as `km/h` or `mph`.
unknown(Boolean) - Method in class com.mapbox.api.directions.v5.models.MaxSpeed.Builder
Boolean is true if the speed limit is not known, otherwise null.
unknown() - Method in class com.mapbox.api.directions.v5.models.MaxSpeed
Boolean is true if the speed limit is not known, otherwise null.
user(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
The user value that was used during the request.
user() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
The same user which was used during the request that resulted in this root directions response.
uuid(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
uuid() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse
A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.

V

valid(Boolean) - Method in class com.mapbox.api.directions.v5.models.IntersectionLanes.Builder
Provide a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver.
valid() - Method in class com.mapbox.api.directions.v5.models.IntersectionLanes
Provides a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver.
view(BannerView) - Method in class com.mapbox.api.directions.v5.models.BannerInstructions.Builder
Optional image to display for an upcoming maneuver.
view() - Method in class com.mapbox.api.directions.v5.models.BannerInstructions
Optional image to display for an upcoming maneuver.
voiceInstructions(List<VoiceInstructions>) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
The voice instructions object is useful for navigation sessions providing well spoken text instructions along with the distance from the maneuver the instructions should be said.
voiceInstructions() - Method in class com.mapbox.api.directions.v5.models.LegStep
The voice instructions object is useful for navigation sessions providing well spoken text instructions along with the distance from the maneuver the instructions should be said.
voiceInstructions(Boolean) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default).
voiceInstructions() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default).
VoiceInstructions - Class in com.mapbox.api.directions.v5.models
This class provides information thats useful for properly making navigation announcements at the correct time.
VoiceInstructions() - Constructor for class com.mapbox.api.directions.v5.models.VoiceInstructions
 
VoiceInstructions.Builder - Class in com.mapbox.api.directions.v5.models
This builder can be used to set the values describing the VoiceInstructions.
voiceLanguage(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
String of the language to be used for voice instructions.
voiceLanguage() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
String of the language to be used for voice instructions.
voiceUnits(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Specify which type of units to return in the text for voice instructions.
voiceUnits() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A type of units to return in the text for voice instructions.

W

walkingOptions(WalkingOptions) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
To be used to specify settings for use with the walking profile.
walkingOptions() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
To be used to specify settings for use with the walking profile.
WalkingOptions - Class in com.mapbox.api.directions.v5
Class for specifying options for use with the walking profile.
WalkingOptions() - Constructor for class com.mapbox.api.directions.v5.WalkingOptions
 
WalkingOptions.Builder - Class in com.mapbox.api.directions.v5
This builder is used to create a new object with specifications relating to walking directions.
WalkingOptionsAdapterFactory - Class in com.mapbox.api.directions.v5
Required so that AutoValue can generate specific type adapters when needed inside the direction packages.
WalkingOptionsAdapterFactory() - Constructor for class com.mapbox.api.directions.v5.WalkingOptionsAdapterFactory
 
walkingSpeed(Double) - Method in class com.mapbox.api.directions.v5.WalkingOptions.Builder
Walking speed in meters per second.
walkingSpeed() - Method in class com.mapbox.api.directions.v5.WalkingOptions
Walking speed in meters per second.
walkwayBias(Double) - Method in class com.mapbox.api.directions.v5.WalkingOptions.Builder
A bias which determines whether the route should prefer or avoid the use of roads or paths that are set aside for pedestrian-only use (walkways).
walkwayBias() - Method in class com.mapbox.api.directions.v5.WalkingOptions
A bias which determines whether the route should prefer or avoid the use of roads or paths that are set aside for pedestrian-only use (walkways).
waypointIndices(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Indicates which input coordinates should be treated as waypoints.
waypointIndices() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Indicates which input coordinates should be treated as waypoints.
waypointIndicesList(List<Integer>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
Indicates which input coordinates should be treated as waypoints.
waypointIndicesList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
Indicates which input coordinates should be treated as waypoints.
waypointNames(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
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.
waypointNames() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
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.
waypointNamesList(List<String>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
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.
waypointNamesList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
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.
waypoints(List<DirectionsWaypoint>) - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse.Builder
List of DirectionsWaypoint objects.
waypoints() - Method in class com.mapbox.api.directions.v5.models.DirectionsResponse
List of DirectionsWaypoint objects.
waypointTargets(String) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates.
waypointTargets() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates.
waypointTargetsList(List<Point>) - Method in class com.mapbox.api.directions.v5.models.RouteOptions.Builder
A list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates.
waypointTargetsList() - Method in class com.mapbox.api.directions.v5.models.RouteOptions
A list of points used to specify drop-off locations that are distinct from the locations specified in coordinates.
weight(Double) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
The calculated weight of the route.
weight() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
The calculated weight of the route.
weight(double) - Method in class com.mapbox.api.directions.v5.models.LegStep.Builder
Specifies a decimal precision of edge weights, default value 1.
weight() - Method in class com.mapbox.api.directions.v5.models.LegStep
Specifies a decimal precision of edge weights, default value 1.
weightName(String) - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute.Builder
The name of the weight profile used while calculating during extraction phase.
weightName() - Method in class com.mapbox.api.directions.v5.models.DirectionsRoute
The name of the weight profile used while calculating during extraction phase.
A B C D E F G I J L M N O P R S T U V W 
Skip navigation links