com.mapbox.services.api

Class MapboxBuilder

java.lang.Object

com.mapbox.services.api.MapboxBuilder

Direct Known Subclasses:

MapboxDirections.Builder, MapboxDirectionsMatrix.Builder, MapboxDistance.Builder, MapboxGeocoding.Builder, MapboxMapMatching.Builder, MapboxOptimizedTrips.Builder, MapboxStaticImage.Builder

public abstract class MapboxBuilder
extends java.lang.Object

Abstract class containing Mapbox specific methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseUrl
protected java.lang.String	clientAppName

Constructor Summary

Constructors

Constructor and Description
MapboxBuilder()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	build() The builder.
abstract java.lang.String	getAccessToken()
java.lang.String	getBaseUrl() Get the base url of the API.
java.lang.String	getClientAppName()
abstract MapboxBuilder	setAccessToken(java.lang.String accessToken)
abstract <T extends MapboxBuilder> T	setBaseUrl(java.lang.String baseUrl) Set the base url of the API.
abstract <T extends MapboxBuilder> T	setClientAppName(java.lang.String appName) Set the App Name to identify
protected void	validateAccessToken(java.lang.String accessToken) Method to validate a Mapbox Access token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientAppName

protected java.lang.String clientAppName

baseUrl

protected java.lang.String baseUrl

Constructor Detail

MapboxBuilder

public MapboxBuilder()

Method Detail

setAccessToken

public abstract MapboxBuilder setAccessToken(java.lang.String accessToken)

getAccessToken

public abstract java.lang.String getAccessToken()

setBaseUrl

public abstract <T extends MapboxBuilder> T setBaseUrl(java.lang.String baseUrl)

Set the base url of the API.

Type Parameters:

T - the concrete implementation of MapboxBuilder

Parameters:

baseUrl - base url used as end point

Returns:

the current MapboxBuilder instance

Since:

2.0.0

getBaseUrl

public java.lang.String getBaseUrl()

Get the base url of the API.

Returns:

the base url used as endpoint.

Since:

2.0.0

setClientAppName

public abstract <T extends MapboxBuilder> T setClientAppName(java.lang.String appName)

Set the App Name to identify

Type Parameters:

T - The concrete implementation of MapboxBuilder

Parameters:

appName - base package name or other simple string identifier

Returns:

the current MapboxBuilder instance

getClientAppName

public java.lang.String getClientAppName()

validateAccessToken

protected void validateAccessToken(java.lang.String accessToken)
                            throws ServicesException

Method to validate a Mapbox Access token.

Parameters:

accessToken - A string containing a Mapbox Access Token

Throws:

ServicesException - Generic Exception for all things Mapbox.

Since:

1.0.0

build

public abstract java.lang.Object build()
                                throws ServicesException

The builder.

Returns:

MapboxBuilder

Throws:

ServicesException - Generic Exception for all things Mapbox.

Since:

1.0.0