com.mapbox.api.directions.v5.models

Class DirectionsResponse.Builder

java.lang.Object

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

Enclosing class:

DirectionsResponse

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract DirectionsResponse	build() Build a new DirectionsResponse object.
abstract DirectionsResponse.Builder	code(java.lang.String code) String indicating the state of the response.
abstract DirectionsResponse.Builder	message(java.lang.String message) Optionally shows up in a directions response if an error or something unexpected occurred.
abstract DirectionsResponse.Builder	routes(java.util.List<DirectionsRoute> routes) List containing all the different route options.
abstract DirectionsResponse.Builder	uuid(java.lang.String uuid) A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
abstract DirectionsResponse.Builder	waypoints(java.util.List<DirectionsWaypoint> waypoints) List of DirectionsWaypoint objects.

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

code

public abstract DirectionsResponse.Builder code(@NonNull
                                                java.lang.String code)

String indicating the state of the response. This is a separate code than the HTTP status code. On normal valid responses, the value will be Ok. For a full list of possible responses, see DirectionsResponse.code().

Parameters:

code - a string with one of the given values described in the list above

Returns:

this builder for chaining options together

Since:

3.0.0

message

public abstract DirectionsResponse.Builder message(@Nullable
                                                   java.lang.String message)

Optionally shows up in a directions response if an error or something unexpected occurred.

Parameters:

message - a string containing the message API Directions response with if an error occurred

Returns:

this builder for chaining options together

Since:

3.0.0

waypoints

public abstract DirectionsResponse.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.

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

routes

public abstract DirectionsResponse.Builder routes(@NonNull
                                                  java.util.List<DirectionsRoute> routes)

List containing all the different route options. It's ordered by descending recommendation rank. In other words, object 0 in the List is the highest recommended route. if you don't setAlternatives to true (default is false) in your builder this should always be a List of size 1. At most this will return 2 DirectionsRoute objects.

Parameters:

routes - list of DirectionsRoute objects

Returns:

this builder for chaining options together

Since:

3.0.0

uuid

public abstract DirectionsResponse.Builder uuid(@Nullable
                                                java.lang.String uuid)

A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.

Parameters:

uuid - a String representing the UUID given by the directions request

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract DirectionsResponse build()

Build a new DirectionsResponse object.

Returns:

a new DirectionsResponse using the provided values in this builder

Since:

3.0.0