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	durationTypical(java.lang.Double durationTypical) The typical travel time from this route's 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	requestUuid(java.lang.String requestUuid) The universally unique identifier of the request that produced this route.
abstract DirectionsRoute.Builder	routeIndex(java.lang.String routeIndex) The index of the route in the list of routes returned by the original response.
abstract DirectionsRoute.Builder	routeOptions(RouteOptions routeOptions) Holds onto the parameter information used when making the directions request.
abstract DirectionsRoute.Builder	tollCosts(java.util.List<TollCost> tollCosts)
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 DirectionsRoute.Builder	voiceLanguage(java.lang.String voiceLanguage) String of the language to be used for voice instructions.
abstract DirectionsRoute.Builder	waypoints(java.util.List<DirectionsWaypoint> waypoints) List of DirectionsWaypoint objects.
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

@NonNull
public abstract DirectionsRoute.Builder distance(@NonNull
                                                          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

@NonNull
public abstract DirectionsRoute.Builder duration(@NonNull
                                                          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

durationTypical

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

The typical travel time from this route's origin to destination. There's a delay along this route if you subtract this durationTypical() value from the route's 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

geometry

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

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

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

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

waypoints

@NonNull
public abstract DirectionsRoute.Builder waypoints(@Nullable
                                                           java.util.List<DirectionsWaypoint> waypoints)

List of DirectionsWaypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoint appear in the list in the order of the input coordinates. Waypoints are returned in the DirectionsRoute object only when RouteOptions.waypointsPerRoute() is set to true. Otherwise they are returned in the root: DirectionsResponse.waypoints().

Parameters:

waypoints - list of DirectionsWaypoint objects ordered from start of route till the end

Returns:

this builder for chaining options together

routeOptions

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

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

requestUuid

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

The universally unique identifier of the request that produced this route.

Parameters:

requestUuid - uuid

Returns:

this builder for chaining options together

routeIndex

@NonNull
public abstract DirectionsRoute.Builder routeIndex(java.lang.String routeIndex)

The index of the route in the list of routes returned by the original response.

Parameters:

routeIndex - string of an int value representing the index

Returns:

this builder for chaining options together

tollCosts

@NonNull
public abstract DirectionsRoute.Builder tollCosts(@Nullable
                                                           java.util.List<TollCost> tollCosts)

build

@NonNull
public abstract DirectionsRoute build()

Build a new DirectionsRoute object.

Returns:

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