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	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	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	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.

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 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

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

summary

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

steps

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

annotation

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

build

public abstract RouteLeg build()

Build a new RouteLeg object.

Returns:

a new RouteLeg using the provided values in this builder

Since:

3.0.0