com.mapbox.api.matching.v5.models

Class MapMatchingMatching.Builder

java.lang.Object

com.mapbox.api.matching.v5.models.MapMatchingMatching.Builder

Enclosing class:

MapMatchingMatching

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapMatchingMatching	build() Build a new MapMatchingMatching object.
abstract MapMatchingMatching.Builder	confidence(double confidence) A number between 0 (low) and 1 (high) indicating level of confidence in the returned match.
abstract MapMatchingMatching.Builder	distance(double distance) The distance traveled from origin to destination.
abstract MapMatchingMatching.Builder	duration(double duration) The estimated travel time from origin to destination.
abstract MapMatchingMatching.Builder	geometry(java.lang.String geometry) Gives the geometry of the route.
abstract MapMatchingMatching.Builder	legs(java.util.List<com.mapbox.api.directions.v5.models.RouteLeg> legs) A Leg is a route between only two waypoints.
abstract MapMatchingMatching.Builder	requestUuid(java.lang.String requestUuid) The universally unique identifier of the request that produced this route.
abstract MapMatchingMatching.Builder	routeIndex(java.lang.String routeIndex) The index of the route in the list of routes returned by the original response.
abstract MapMatchingMatching.Builder	routeOptions(com.mapbox.api.directions.v5.models.RouteOptions routeOptions) Holds onto the parameter information used when making the directions request.
abstract MapMatchingMatching.Builder	voiceLanguage(java.lang.String voiceLanguage) String of the language to be used for voice instructions.
abstract MapMatchingMatching.Builder	weight(double weight) The calculated weight of the route.
abstract MapMatchingMatching.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 MapMatchingMatching.Builder distance(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 MapMatchingMatching.Builder duration(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

@NonNull
public abstract MapMatchingMatching.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 MapMatchingMatching.Builder weight(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 MapMatchingMatching.Builder weightName(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 MapMatchingMatching.Builder legs(java.util.List<com.mapbox.api.directions.v5.models.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

confidence

@NonNull
public abstract MapMatchingMatching.Builder confidence(double confidence)

A number between 0 (low) and 1 (high) indicating level of confidence in the returned match.

Parameters:

confidence - confidence value

Returns:

this builder for chaining options together

Since:

3.0.0

routeOptions

@NonNull
public abstract MapMatchingMatching.Builder routeOptions(@Nullable
                                                                  com.mapbox.api.directions.v5.models.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 MapMatchingMatching.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. Should be null when the language provided via MapboxMapMatching.language() is not compatible with API Voice.

Parameters:

voiceLanguage - String compatible with voice instructions, null otherwise

Returns:

this builder for chaining options together

Since:

3.4.0

requestUuid

@NonNull
public abstract MapMatchingMatching.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 MapMatchingMatching.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

build

@NonNull
public abstract MapMatchingMatching build()

Build a new MapMatchingMatching object.

Returns:

a new MapMatchingMatching using the provided values in this builder

Since:

3.0.0