com.mapbox.api.directions.v5

Class MapboxDirections.Builder

java.lang.Object

com.mapbox.api.directions.v5.MapboxDirections.Builder

Enclosing class:

MapboxDirections

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

Builder class used to create a new instance of MapboxDirections.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapboxDirections.Builder	accessToken(java.lang.String accessToken) A valid Mapbox Access Token used to making the request.
abstract MapboxDirections	build() This uses the provided parameters set using the MapboxDirections.Builder and first checks that all values are valid, and creates a new MapboxDirections object with the values provided.
abstract MapboxDirections.Builder	clientAppName(java.lang.String clientAppName) Base package name or other simple string identifier.
abstract MapboxDirections.Builder	eventListener(okhttp3.EventListener eventListener) Adds an optional event listener to set in the OkHttp client.
abstract MapboxDirections.Builder	interceptor(okhttp3.Interceptor interceptor) Adds an optional interceptor to set in the OkHttp client.
abstract MapboxDirections.Builder	networkInterceptor(okhttp3.Interceptor interceptor) Adds an optional network interceptor to set in the OkHttp client.
abstract MapboxDirections.Builder	routeOptions(com.mapbox.api.directions.v5.models.RouteOptions routeOptions) Set of options specified for this directions request.
abstract MapboxDirections.Builder	usePostMethod(java.lang.Boolean usePost) Use POST method to request data.

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

accessToken

@NonNull
public abstract MapboxDirections.Builder accessToken(@NonNull
                                                              java.lang.String accessToken)

A valid Mapbox Access Token used to making the request.

Learn more about the tokens here.

Parameters:

accessToken - a string representing the Mapbox Access Token

Returns:

this builder for chaining options together

routeOptions

@NonNull
public abstract MapboxDirections.Builder routeOptions(@NonNull
                                                               com.mapbox.api.directions.v5.models.RouteOptions routeOptions)

Set of options specified for this directions request.

The options defined here reflect Directions API documentation. Warning: `MapboxDirections` doesn't support unrecognized properties from `RouteOptions`.

Parameters:

routeOptions - route request options

Returns:

this builder for chaining options together

clientAppName

public abstract MapboxDirections.Builder clientAppName(@Nullable
                                                       java.lang.String clientAppName)

Base package name or other simple string identifier. Used inside the calls user agent header.

Parameters:

clientAppName - base package name or other simple string identifier

Returns:

this builder for chaining options together

Since:

1.0.0

interceptor

public abstract MapboxDirections.Builder interceptor(@Nullable
                                                     okhttp3.Interceptor interceptor)

Adds an optional interceptor to set in the OkHttp client.

Parameters:

interceptor - to set for OkHttp

Returns:

this builder for chaining options together

networkInterceptor

public abstract MapboxDirections.Builder networkInterceptor(@Nullable
                                                            okhttp3.Interceptor interceptor)

Adds an optional network interceptor to set in the OkHttp client.

Parameters:

interceptor - to set for OkHttp

Returns:

this builder for chaining options together

eventListener

public abstract MapboxDirections.Builder eventListener(@Nullable
                                                       okhttp3.EventListener eventListener)

Adds an optional event listener to set in the OkHttp client.

Parameters:

eventListener - to set for OkHttp

Returns:

this builder for chaining options together

usePostMethod

public abstract MapboxDirections.Builder usePostMethod(@Nullable
                                                       java.lang.Boolean usePost)

Use POST method to request data. If null, the default is to use GET unless the length of a URL would exceed MapboxService.MAX_URL_SIZE, then POST is used by default.

Parameters:

usePost - true to use POST method or false and null for GET method

Returns:

this builder for chaining options together

build

public abstract MapboxDirections build()

This uses the provided parameters set using the MapboxDirections.Builder and first checks that all values are valid, and creates a new MapboxDirections object with the values provided.

Returns:

a new instance of Mapbox Directions