com.mapbox.api.geocoding.v6

Class MapboxV6BaseGeocoding.BaseBuilder<T>

java.lang.Object

com.mapbox.api.geocoding.v6.MapboxV6BaseGeocoding.BaseBuilder<T>

Type Parameters:

T - type of Builder

Direct Known Subclasses:

MapboxV6BatchGeocoding.Builder, MapboxV6Geocoding.Builder

Enclosing class:

MapboxV6BaseGeocoding<T>

public abstract static class MapboxV6BaseGeocoding.BaseBuilder<T>
extends java.lang.Object

Base class for Mapbox V6 Geocoding Builders.

Constructor Summary

Constructors

Constructor and Description
BaseBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract T	accessToken(java.lang.String accessToken)
abstract T	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Mapbox one.
abstract T	clientAppName(java.lang.String clientAppName) Base package name or other simple string identifier.
abstract T	permanent(java.lang.Boolean permanent) Specify whether you intend to store the results of the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseBuilder

public BaseBuilder()

Method Detail

accessToken

protected abstract T accessToken(@NonNull
                                 java.lang.String accessToken)

permanent

public abstract T permanent(@NonNull
                            java.lang.Boolean permanent)

Specify whether you intend to store the results of the query. Backend default is false.

Parameters:

permanent - specify whether you intend to store the results

Returns:

this builder for chaining options together

See Also:

Storing Geocoding Results

clientAppName

public abstract T 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

baseUrl

public abstract T 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