com.nbmap.api.routetiles.v1.versions

Class NbmapRouteTileVersions.Builder

java.lang.Object

com.nbmap.api.routetiles.v1.versions.NbmapRouteTileVersions.Builder

Enclosing class:

NbmapRouteTileVersions

public abstract static class NbmapRouteTileVersions.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.

Since:

4.1.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract NbmapRouteTileVersions.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
abstract NbmapRouteTileVersions.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Nbmap one.
NbmapRouteTileVersions	build() This uses the provided parameters set using the NbmapRouteTileVersions.Builder and first checks that all values are valid, and creates a new NbmapRouteTileVersions object with the values provided.
abstract NbmapRouteTileVersions.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 NbmapRouteTileVersions.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 NbmapRouteTileVersions.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 NbmapRouteTileVersions.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 NbmapRouteTileVersions build()

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

Returns:

a new instance of Nbmap Route Tiles Version

Throws:

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

Since:

4.1.0