com.mapbox.api.directions.v5.models

Class RouteLeg

java.lang.Object

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

com.mapbox.api.directions.v5.models.RouteLeg

All Implemented Interfaces:

java.io.Serializable

public abstract class RouteLeg
extends DirectionsJsonObject

A route between only two DirectionsWaypoint.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RouteLeg()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<Admin>	admins() An array of objects describing the administrative boundaries the route leg travels through.
abstract LegAnnotation	annotation() A LegAnnotation that contains additional details about each line segment along the route geometry.
static RouteLeg.Builder	builder() Create a new instance of this class by using the RouteLeg.Builder class.
abstract java.util.List<Closure>	closures() A list of closures that occur on this leg.
abstract java.lang.Double	distance() The distance traveled from one waypoint to another.
abstract java.lang.Double	duration() The estimated travel time from one waypoint to another.
abstract java.lang.Double	durationTypical() The typical travel time for traversing this RouteLeg.
static RouteLeg	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.util.List<Incident>	incidents() A list of incidents that occur on this leg.
abstract java.util.List<LegStep>	steps() Gives a List including all the steps to get from one waypoint to another.
abstract java.lang.String	summary() A short human-readable summary of major roads traversed.
abstract RouteLeg.Builder	toBuilder() Convert the current RouteLeg to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<RouteLeg>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.util.List<SilentWaypoint>	viaWaypoints() When the semicolon-separated list waypoints parameter is used in the request, an array per leg is returned that describes where a particular waypoint from the root-level array matches to the route.

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

RouteLeg

public RouteLeg()

Method Detail

builder

public static RouteLeg.Builder builder()

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

Returns:

this classes RouteLeg.Builder for creating a new instance

Since:

3.0.0

viaWaypoints

@Nullable
 @SerializedName(value="via_waypoints")
public abstract java.util.List<SilentWaypoint> viaWaypoints()

When the semicolon-separated list waypoints parameter is used in the request, an array per leg is returned that describes where a particular waypoint from the root-level array matches to the route. This provides a way for tracking when a waypoint is passed along the route.

Returns:

a list of silent waypoints

distance

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

The distance traveled from one waypoint to another.

Returns:

a double number with unit meters

Since:

1.0.0

duration

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

The estimated travel time from one waypoint to another.

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 for traversing this RouteLeg. There's a delay along the RouteLeg if you subtract this durationTypical() value from the RouteLeg 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

summary

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

A short human-readable summary of major roads traversed. Useful to distinguish alternatives.

Returns:

String with summary

Since:

1.0.0

admins

@Nullable
public abstract java.util.List<Admin> admins()

An array of objects describing the administrative boundaries the route leg travels through. Use StepIntersection.adminIndex() on the intersection object to look up the admin for each intersection in this array.

steps

@Nullable
public abstract java.util.List<LegStep> steps()

Gives a List including all the steps to get from one waypoint to another.

Returns:

List of LegStep

Since:

1.0.0

incidents

@Nullable
public abstract java.util.List<Incident> incidents()

A list of incidents that occur on this leg.

Returns:

a list of Incident

annotation

@Nullable
public abstract LegAnnotation annotation()

A LegAnnotation that contains additional details about each line segment along the route geometry. If you'd like to receiving this, you must request it inside your Directions request before executing the call.

Returns:

a LegAnnotation object

Since:

2.1.0

closures

@Nullable
public abstract java.util.List<Closure> closures()

A list of closures that occur on this leg.

Returns:

a list of Closure

toBuilder

public abstract RouteLeg.Builder toBuilder()

Convert the current RouteLeg 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 RouteLeg.

Returns:

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

Since:

3.1.0

typeAdapter

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

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

Parameters:

json - a formatted valid JSON string defining a RouteLeg

Returns:

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

Since:

3.4.0