com.nbmap.api.routetiles.v1

Class NbmapRouteTiles.Builder

java.lang.Object

com.nbmap.api.routetiles.v1.NbmapRouteTiles.Builder

Enclosing class:

NbmapRouteTiles

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

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

Since:

4.1.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract NbmapRouteTiles.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
abstract NbmapRouteTiles.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Nbmap one.
abstract NbmapRouteTiles.Builder	boundingBox(com.nbmap.geojson.BoundingBox boundingBox) The bounding box of which to download map route tiles.
NbmapRouteTiles	build() This uses the provided parameters set using the NbmapRouteTiles.Builder and first checks that all values are valid, and creates a new NbmapRouteTiles object with the values provided.
abstract NbmapRouteTiles.Builder	clientAppName(java.lang.String clientAppName) Base package name or other simple string identifier.
abstract NbmapRouteTiles.Builder	interceptor(okhttp3.Interceptor interceptor) Adds an optional interceptor to set in the OkHttp client.
abstract NbmapRouteTiles.Builder	networkInterceptor(okhttp3.Interceptor interceptor) Adds an optional network interceptor to set in the OkHttp client.
abstract NbmapRouteTiles.Builder	version(java.lang.String version) The version of map tiles being requested.

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

boundingBox

public abstract NbmapRouteTiles.Builder boundingBox(@NonNull
                                                    com.nbmap.geojson.BoundingBox boundingBox)

The bounding box of which to download map route tiles.

Parameters:

boundingBox - of which to download map route tiles

Returns:

this builder for chaining options together

Since:

4.1.0

version

public abstract NbmapRouteTiles.Builder version(@NonNull
                                                java.lang.String version)

The version of map tiles being requested. To get a list of the versions, use the NbmapRouteTileVersions API.

Parameters:

version - of which to download

Returns:

this builder for chaining options together

Since:

4.1.0

accessToken

public abstract NbmapRouteTiles.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 - Nbmap access token, You must have a Nbmap account inorder to use the Route Tiles API

Returns:

this builder for chaining options together

Since:

4.1.0

baseUrl

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

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

Parameters:

baseUrl - base url used as end point

Returns:

this builder for chaining options together

Since:

4.1.0

clientAppName

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

interceptor

public abstract NbmapRouteTiles.Builder interceptor(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 NbmapRouteTiles.Builder networkInterceptor(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

build

public NbmapRouteTiles build()

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

Returns:

a new instance of Nbmap Route Tiles

Throws:

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

Since:

4.1.0