com.mapbox.api.routetiles.v1.versions

Class MapboxRouteTileVersions.Builder

java.lang.Object

com.mapbox.api.routetiles.v1.versions.MapboxRouteTileVersions.Builder

Enclosing class:

MapboxRouteTileVersions

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

This builder is used to create a new request to the Mapbox Route Tiles API. At a bare minimum, your request must include an access token.

Since:

4.1.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapboxRouteTileVersions.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
abstract MapboxRouteTileVersions.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Mapbox one.
MapboxRouteTileVersions	build() This uses the provided parameters set using the MapboxRouteTileVersions.Builder and first checks that all values are valid, and creates a new MapboxRouteTileVersions object with the values provided.
abstract MapboxRouteTileVersions.Builder	clientAppName(java.lang.String clientAppName) Base package name or other simple string identifier.

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

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

Required to call when this is being built. If no access token provided, ServicesException will be thrown.

Parameters:

accessToken - Mapbox access token, You must have a Mapbox account inorder to use the Route Tiles API

Returns:

this builder for chaining options together

Since:

4.1.0

baseUrl

public abstract MapboxRouteTileVersions.Builder baseUrl(@NonNull
                                                        java.lang.String baseUrl)

Optionally change the APIs base URL to something other then the default Mapbox one.

Parameters:

baseUrl - base url used as end point

Returns:

this builder for chaining options together

Since:

4.1.0

clientAppName

public abstract MapboxRouteTileVersions.Builder clientAppName(@NonNull
                                                              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:

4.1.0

build

public MapboxRouteTileVersions build()

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

Returns:

a new instance of Mapbox Route Tiles Version

Throws:

com.mapbox.core.exceptions.ServicesException - when a provided parameter is detected to be incorrect

Since:

4.1.0