com.mapbox.api.directions.v5.models

Class DirectionsRoute

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.DirectionsRoute

All Implemented Interfaces:

java.io.Serializable

public abstract class DirectionsRoute
extends DirectionsJsonObject

Detailed information about an individual route such as the duration, distance and geometry.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectionsRoute.Builder This builder can be used to set the values describing the DirectionsRoute.

Constructor Summary

Constructors

Constructor and Description
DirectionsRoute()

Method Summary

Modifier and Type	Method and Description
static DirectionsRoute.Builder	builder() Create a new instance of this class by using the DirectionsRoute.Builder class.
abstract java.lang.Double	distance() The distance traveled from origin to destination.
abstract java.lang.Double	duration() The estimated travel time from origin to destination.
abstract java.lang.Double	durationTypical() The typical travel time from this route's origin to destination.
static DirectionsRoute	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
static DirectionsRoute	fromJson(java.lang.String json, RouteOptions routeOptions, java.lang.String requestUuid) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	geometry() Gives the geometry of the route.
abstract java.util.List<RouteLeg>	legs() A Leg is a route between only two waypoints.
abstract java.lang.String	requestUuid() The universally unique identifier of the request that produced this route.
abstract java.lang.String	routeIndex() The index of this route in the original network response.
abstract RouteOptions	routeOptions() Holds onto the parameter information used when making the directions request.
abstract DirectionsRoute.Builder	toBuilder() Convert the current DirectionsRoute to its builder holding the currently assigned values.
abstract java.util.List<TollCost>	tollCosts()
static com.google.gson.TypeAdapter<DirectionsRoute>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.String	voiceLanguage() String of the language to be used for voice instructions.
abstract java.lang.Double	weight() The calculated weight of the route.
abstract java.lang.String	weightName() The name of the weight profile used while calculating during extraction phase.

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

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectionsRoute

public DirectionsRoute()

Method Detail

builder

public static DirectionsRoute.Builder builder()

Create a new instance of this class by using the DirectionsRoute.Builder class.

Returns:

this classes DirectionsRoute.Builder for creating a new instance

Since:

3.0.0

routeIndex

@Nullable
public abstract java.lang.String routeIndex()

The index of this route in the original network response.

Returns:

string of an int value representing the index

Since:

4.4.0

distance

@NonNull
public abstract java.lang.Double distance()

The distance traveled from origin to destination.

Returns:

a double number with unit meters

Since:

1.0.0

duration

@NonNull
public abstract java.lang.Double duration()

The estimated travel time from origin to destination.

Returns:

a double number with unit seconds

Since:

1.0.0

durationTypical

@Nullable
 @SerializedName(value="duration_typical")
public abstract java.lang.Double durationTypical()

The typical travel time from this route's origin to destination. There's a delay along this route if you subtract this durationTypical() value from the route's duration() value and the resulting difference is greater than 0. The delay is because of any number of real-world situations (road repair, traffic jam, etc).

Returns:

a double number with unit seconds

Since:

5.5.0

geometry

@Nullable
public abstract java.lang.String geometry()

Gives the geometry of the route. Commonly used to draw the route on the map view.

Returns:

an encoded polyline string

Since:

1.0.0

weight

@Nullable
public abstract java.lang.Double weight()

The calculated weight of the route.

Returns:

the weight value provided from the API as a double value

Since:

2.1.0

weightName

@Nullable
 @SerializedName(value="weight_name")
public abstract java.lang.String weightName()

The name of the weight profile used while calculating during extraction phase. The default is routability which is duration based, with additional penalties for less desirable maneuvers.

Returns:

a String representing the weight profile used while calculating the route

Since:

2.1.0

legs

@Nullable
public abstract java.util.List<RouteLeg> legs()

A Leg is a route between only two waypoints.

Returns:

list of RouteLeg objects

Since:

1.0.0

routeOptions

@Nullable
public abstract RouteOptions routeOptions()

Holds onto the parameter information used when making the directions request. Useful for re-requesting a directions route using the same information previously used.

Returns:

a RouteOptionss object which holds onto critical information from the request that cannot be derived directly from the directions route

Since:

3.0.0

voiceLanguage

@Nullable
 @SerializedName(value="voiceLocale")
public abstract java.lang.String voiceLanguage()

String of the language to be used for voice instructions. Defaults to en, and can be any accepted instruction language. Will be null when the language provided MapboxDirections.Builder#language() via is not compatible with API Voice.

Returns:

String compatible with voice instructions, null otherwise

Since:

3.1.0

requestUuid

@Nullable
public abstract java.lang.String requestUuid()

The universally unique identifier of the request that produced this route.

Returns:

request uuid

tollCosts

@Nullable
 @SerializedName(value="toll_costs")
public abstract java.util.List<TollCost> tollCosts()

toBuilder

public abstract DirectionsRoute.Builder toBuilder()

Convert the current DirectionsRoute to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified DirectionsRoute.

Returns:

a DirectionsRoute.Builder with the same values set to match the ones defined in this DirectionsRoute

Since:

3.0.0

typeAdapter

public static com.google.gson.TypeAdapter<DirectionsRoute> 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 DirectionsRoute fromJson(@NonNull
                                       java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

If you're using the provided route with the Mapbox Navigation SDK, also see fromJson(String, RouteOptions, String).

Parameters:

json - a formatted valid JSON string defining a GeoJson Directions Route

Returns:

a new instance of this class defined by the values passed inside this static factory method

fromJson

public static DirectionsRoute fromJson(@NonNull
                                       java.lang.String json,
                                       @Nullable
                                       RouteOptions routeOptions,
                                       @Nullable
                                       java.lang.String requestUuid)

Create a new instance of this class by passing in a formatted valid JSON String.

The parameters of RouteOptions that were used to make the original route request as well as the String UUID of the original response are needed by the Mapbox Navigation SDK to support correct rerouting and route refreshing.

Parameters:

json - a formatted valid JSON string defining a GeoJson Directions Route

routeOptions - options that were used during the original route request

requestUuid - UUID of the request found in the body of the original response, see "response.body.uuid"

Returns:

a new instance of this class defined by the values passed inside this static factory method

See Also:

RouteOptions.fromUrl(java.net.URL), RouteOptions.fromJson(String)