com.mapbox.api.directions.v5.models

Class RouteLeg.Builder

java.lang.Object

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

Enclosing class:

RouteLeg

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract RouteLeg.Builder	admins(java.util.List<Admin> admins) An array of objects describing the administrative boundaries the route leg travels through.
abstract RouteLeg.Builder	annotation(LegAnnotation annotation) A LegAnnotation that contains additional details about each line segment along the route geometry.
abstract RouteLeg	build() Build a new RouteLeg object.
abstract RouteLeg.Builder	closures(java.util.List<Closure> closures) A list of closures that occur on this leg.
abstract RouteLeg.Builder	distance(java.lang.Double distance) The distance traveled from one waypoint to another.
abstract RouteLeg.Builder	duration(java.lang.Double duration) The estimated travel time from one waypoint to another.
abstract RouteLeg.Builder	durationTypical(java.lang.Double durationTypical) The typical travel time for traversing this RouteLeg.
abstract RouteLeg.Builder	incidents(java.util.List<Incident> incidents) A list of incidents that occur on this leg.
abstract RouteLeg.Builder	steps(java.util.List<LegStep> steps) Gives a List including all the steps to get from one waypoint to another.
abstract RouteLeg.Builder	summary(java.lang.String summary) A short human-readable summary of major roads traversed.
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.
abstract RouteLeg.Builder	viaWaypoints(java.util.List<SilentWaypoint> viaWaypoints) A list of silent waypoints which were used to request a route.

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

viaWaypoints

@NonNull
public abstract RouteLeg.Builder viaWaypoints(@Nullable
                                                       java.util.List<SilentWaypoint> viaWaypoints)

A list of silent waypoints which were used to request a route.

Parameters:

viaWaypoints - a list of silent waypoints

Returns:

this builder for chaining options together

distance

@NonNull
public abstract RouteLeg.Builder distance(@Nullable
                                                   java.lang.Double distance)

The distance traveled from one waypoint to another.

Parameters:

distance - a double number with unit meters

Returns:

this builder for chaining options together

Since:

3.0.0

duration

@NonNull
public abstract RouteLeg.Builder duration(@Nullable
                                                   java.lang.Double duration)

The estimated travel time from one waypoint to another.

Parameters:

duration - a double number with unit seconds

Returns:

this builder for chaining options together

Since:

1.0.0

durationTypical

@NonNull
public abstract RouteLeg.Builder durationTypical(@Nullable
                                                          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).

Parameters:

durationTypical - a double number with unit seconds

Returns:

this builder for chaining options together

Since:

5.5.0

summary

@NonNull
public abstract RouteLeg.Builder summary(@Nullable
                                                  java.lang.String summary)

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

Parameters:

summary - String with summary

Returns:

this builder for chaining options together

Since:

3.0.0

admins

@NonNull
public abstract RouteLeg.Builder admins(@Nullable
                                                 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.

Parameters:

admins - Array with admins

Returns:

this builder for chaining options together

steps

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

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

Parameters:

steps - List of LegStep

Returns:

this builder for chaining options together

Since:

3.0.0

incidents

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

A list of incidents that occur on this leg.

Parameters:

incidents - a list of Incident

Returns:

this builder for chaining options together

annotation

@NonNull
public abstract RouteLeg.Builder annotation(@Nullable
                                                     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.

Parameters:

annotation - a LegAnnotation object

Returns:

this builder for chaining options together

Since:

3.0.0

closures

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

A list of closures that occur on this leg.

Parameters:

closures - a list of Closure

Returns:

this builder for chaining options together

build

@NonNull
public abstract RouteLeg build()

Build a new RouteLeg object.

Returns:

a new RouteLeg 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