com.mapbox.api.directions.v5.models

Class LegAnnotation

java.lang.Object

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

com.mapbox.api.directions.v5.models.LegAnnotation

All Implemented Interfaces:

java.io.Serializable

public abstract class LegAnnotation
extends DirectionsJsonObject

An annotations object that contains additional details about each line segment along the route geometry. Each entry in an annotations field corresponds to a coordinate along the route geometry.

Since:

2.1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LegAnnotation()

Method Summary

Modifier and Type	Method and Description
static LegAnnotation.Builder	builder() Create a new instance of this class by using the LegAnnotation.Builder class.
abstract java.util.List<java.lang.String>	congestion() The congestion between each pair of coordinates.
abstract java.util.List<java.lang.Integer>	congestionNumeric() The congestion between each pair of coordinates.
abstract java.util.List<java.lang.Integer>	currentSpeed() The speed may be either a positive integer in kilometers per hour or `null` where attribution is missing.
abstract java.util.List<java.lang.Double>	distance() The distance, in meters, between each pair of coordinates.
abstract java.util.List<java.lang.Double>	duration() The speed, in meters per second, between each pair of coordinates.
abstract java.util.List<java.lang.Integer>	freeflowSpeed() The speed may be either a positive integer in kilometers per hour or `null` where attribution is missing.
static LegAnnotation	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.util.List<MaxSpeed>	maxspeed() The posted speed limit, between each pair of coordinates.
abstract java.util.List<java.lang.Double>	speed() The speed, in meters per second, between each pair of coordinates.
abstract LegAnnotation.Builder	toBuilder() Convert the current LegAnnotation to its builder holding the currently assigned values.
abstract java.util.List<java.lang.Integer>	trafficTendency()
static com.google.gson.TypeAdapter<LegAnnotation>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

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

LegAnnotation

public LegAnnotation()

Method Detail

builder

public static LegAnnotation.Builder builder()

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

Returns:

this classes LegAnnotation.Builder for creating a new instance

Since:

3.0.0

distance

@Nullable
public abstract java.util.List<java.lang.Double> distance()

The distance, in meters, between each pair of coordinates.

Returns:

a list with each entry being a distance value between two of the routeLeg geometry coordinates

Since:

2.1.0

duration

@Nullable
public abstract java.util.List<java.lang.Double> duration()

The speed, in meters per second, between each pair of coordinates.

Returns:

a list with each entry being a speed value between two of the routeLeg geometry coordinates

Since:

2.1.0

speed

@Nullable
public abstract java.util.List<java.lang.Double> speed()

The speed, in meters per second, between each pair of coordinates.

Returns:

a list with each entry being a speed value between two of the routeLeg geometry coordinates

Since:

2.1.0

maxspeed

@Nullable
public abstract java.util.List<MaxSpeed> maxspeed()

The posted speed limit, between each pair of coordinates. Maxspeed is only available for the `mapbox/driving` and `mapbox/driving-traffic` profiles, other profiles will return `unknown`s only.

Returns:

a list with each entry being a MaxSpeed value between two of the routeLeg geometry coordinates

Since:

3.0.0

congestion

@Nullable
public abstract java.util.List<java.lang.String> congestion()

The congestion between each pair of coordinates.

Returns:

a list of Strings with each entry being a congestion value between two of the routeLeg geometry coordinates

Since:

2.2.0

congestionNumeric

@Nullable
 @SerializedName(value="congestion_numeric")
public abstract java.util.List<java.lang.Integer> congestionNumeric()

The congestion between each pair of coordinates.

Returns:

a list of Integers with each entry being a congestion value between two of the routeLeg geometry coordinates

trafficTendency

@Nullable
 @SerializedName(value="traffic_tendency")
public abstract java.util.List<java.lang.Integer> trafficTendency()

freeflowSpeed

@Nullable
 @SerializedName(value="freeflow_speed")
public abstract java.util.List<java.lang.Integer> freeflowSpeed()

The speed may be either a positive integer in kilometers per hour or `null` where attribution is missing. The freeflow value conveys the typical speed at low traffic times of day such as nights or early mornings. Available only for `mapbox/driving` and `mapbox/driving-traffic` profiles.

Returns:

The freeflow speed for each line segment along the route geometry.

currentSpeed

@Nullable
 @SerializedName(value="current_speed")
public abstract java.util.List<java.lang.Integer> currentSpeed()

The speed may be either a positive integer in kilometers per hour or `null` where attribution is missing. The current speed value conveys the instantaneous (at the time of the request) speed. Available only for `mapbox/driving` and `mapbox/driving-traffic` profiles.

Returns:

The current speed for each line segment along the route geometry.

toBuilder

public abstract LegAnnotation.Builder toBuilder()

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

Returns:

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

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<LegAnnotation> 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 LegAnnotation 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 LegAnnotation

Returns:

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

Since:

3.4.0