com.mapbox.api.directions.v5.models

Class DirectionsRoute.Builder

java.lang.Object

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

Enclosing class:

DirectionsRoute

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract DirectionsRoute	build() Build a new DirectionsRoute object.
abstract DirectionsRoute.Builder	distance(java.lang.Double distance) The distance traveled from origin to destination.
abstract DirectionsRoute.Builder	duration(java.lang.Double duration) The estimated travel time from origin to destination.
abstract DirectionsRoute.Builder	geometry(java.lang.String geometry) Gives the geometry of the route.
abstract DirectionsRoute.Builder	legs(java.util.List<RouteLeg> legs) A Leg is a route between only two waypoints.
abstract DirectionsRoute.Builder	routeOptions(RouteOptions routeOptions) Holds onto the parameter information used when making the directions request.
abstract DirectionsRoute.Builder	voiceLanguage(java.lang.String voiceLanguage) String of the language to be used for voice instructions.
abstract DirectionsRoute.Builder	weight(java.lang.Double weight) The calculated weight of the route.
abstract DirectionsRoute.Builder	weightName(java.lang.String weightName) The name of the weight profile used while calculating during extraction phase.

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 DirectionsRoute.Builder distance(@Nullable
                                                 java.lang.Double distance)

The distance traveled from origin to destination.

Parameters:

distance - a double number with unit meters

Returns:

this builder for chaining options together

Since:

3.0.0

duration

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

The estimated travel time from origin to destination.

Parameters:

duration - a double number with unit seconds

Returns:

this builder for chaining options together

Since:

3.0.0

geometry

public abstract DirectionsRoute.Builder geometry(@Nullable
                                                 java.lang.String geometry)

Gives the geometry of the route. Commonly used to draw the route on the map view.

Parameters:

geometry - an encoded polyline string

Returns:

this builder for chaining options together

Since:

3.0.0

weight

public abstract DirectionsRoute.Builder weight(@Nullable
                                               java.lang.Double weight)

The calculated weight of the route.

Parameters:

weight - the weight value provided from the API as a double value

Returns:

this builder for chaining options together

Since:

3.0.0

weightName

public abstract DirectionsRoute.Builder weightName(@Nullable
                                                   java.lang.String weightName)

The name of the weight profile used while calculating during extraction phase. The default is routability which is duration based, with additional penalties for less desirable maneuvers.

Parameters:

weightName - a String representing the weight profile used while calculating the route

Returns:

this builder for chaining options together

Since:

3.0.0

legs

public abstract DirectionsRoute.Builder legs(@Nullable
                                             java.util.List<RouteLeg> legs)

A Leg is a route between only two waypoints.

Parameters:

legs - list of RouteLeg objects

Returns:

this builder for chaining options together

Since:

3.0.0

routeOptions

public abstract DirectionsRoute.Builder routeOptions(@Nullable
                                                     RouteOptions routeOptions)

Holds onto the parameter information used when making the directions request.

Parameters:

routeOptions - a RouteOptionss object which holds onto critical information from the request that cannot be derived directly from the directions route

Returns:

this builder for chaining options together

Since:

3.0.0

voiceLanguage

public abstract DirectionsRoute.Builder voiceLanguage(@Nullable
                                                      java.lang.String voiceLanguage)

String of the language to be used for voice instructions. Defaults to en, and can be any accepted instruction language.

Parameters:

voiceLanguage - String compatible with voice instructions, null otherwise

Returns:

this builder for chaining options together

Since:

3.1.0

build

public abstract DirectionsRoute build()

Build a new DirectionsRoute object.

Returns:

a new DirectionsRoute using the provided values in this builder

Since:

3.0.0