com.mapbox.api.directions.v5.models

Class LegAnnotation.Builder

java.lang.Object

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

Enclosing class:

LegAnnotation

public abstract static class LegAnnotation.Builder
extends java.lang.Object

This builder can be used to set the values describing the LegAnnotation.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract LegAnnotation	build() Build a new LegAnnotation object.
abstract LegAnnotation.Builder	congestion(java.util.List<java.lang.String> congestion) The congestion between each pair of coordinates.
abstract LegAnnotation.Builder	congestionNumeric(java.util.List<java.lang.Integer> congestionNumeric) The congestion between each pair of coordinates.
abstract LegAnnotation.Builder	currentSpeed(java.util.List<java.lang.Integer> currentSpeed)
abstract LegAnnotation.Builder	distance(java.util.List<java.lang.Double> distance) The distance, in meters, between each pair of coordinates.
abstract LegAnnotation.Builder	duration(java.util.List<java.lang.Double> duration) The speed, in meters per second, between each pair of coordinates.
abstract LegAnnotation.Builder	freeflowSpeed(java.util.List<java.lang.Integer> freeflowSpeed)
abstract LegAnnotation.Builder	maxspeed(java.util.List<MaxSpeed> maxspeed) The posted speed limit, between each pair of coordinates.
abstract LegAnnotation.Builder	speed(java.util.List<java.lang.Double> speed) The speed, in meters per second, between each pair of coordinates.
abstract LegAnnotation.Builder	trafficTendency(java.util.List<java.lang.Integer> trafficTendency)
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

distance

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

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

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

duration

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

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

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

speed

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

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

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

maxspeed

public abstract LegAnnotation.Builder maxspeed(@Nullable
                                               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.

Parameters:

maxspeed - list of speeds between each pair of coordinates

Returns:

this builder for chaining options together

Since:

3.0.0

congestion

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

The congestion between each pair of coordinates.

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

congestionNumeric

public abstract LegAnnotation.Builder congestionNumeric(@Nullable
                                                        java.util.List<java.lang.Integer> congestionNumeric)

The congestion between each pair of coordinates.

Parameters:

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

Returns:

this builder for chaining options together

trafficTendency

@NonNull
public abstract LegAnnotation.Builder trafficTendency(@Nullable
                                                               java.util.List<java.lang.Integer> trafficTendency)

freeflowSpeed

@NonNull
public abstract LegAnnotation.Builder freeflowSpeed(@Nullable
                                                             java.util.List<java.lang.Integer> freeflowSpeed)

Parameters:

freeflowSpeed - speed for each line segment along the route geometry. The speed may be either a positive integer in kilometers per hour or `null` where attribution is missing.

Returns:

this builder for chaining options together

currentSpeed

@NonNull
public abstract LegAnnotation.Builder currentSpeed(@Nullable
                                                            java.util.List<java.lang.Integer> currentSpeed)

Parameters:

currentSpeed - The current speed for each line segment along the route geometry. The speed may be either a positive integer in kilometers per hour or `null` where attribution is missing.

Returns:

this builder for chaining options together

build

public abstract LegAnnotation build()

Build a new LegAnnotation object.

Returns:

a new LegAnnotation using the provided values in this builder

Since:

3.0.0

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request