com.nbmap.api.speech.v1

Class NbmapSpeech.Builder

java.lang.Object

com.nbmap.api.speech.v1.NbmapSpeech.Builder

Enclosing class:

NbmapSpeech

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

This builder is used to create a NbmapSpeech instance, with details about how the API calls should be made (input/output format, language, etc.). To use caching, specify a cache directory. Access token and instruction are required, along with cache directory if you choose to use caching.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract NbmapSpeech.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
abstract NbmapSpeech.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Nbmap one.
NbmapSpeech	build() This uses the provided parameters set using the NbmapSpeech.Builder and first checks that all values are valid, formats the values as strings for easier consumption by the API, and lastly creates a new NbmapSpeech object with the values provided.
abstract NbmapSpeech.Builder	cache(okhttp3.Cache cache) Adds an optional cache to set in the OkHttp client.
abstract NbmapSpeech.Builder	instruction(java.lang.String instruction) Add the instruction text to dictate, either as plain text or ssml.
abstract NbmapSpeech.Builder	interceptor(okhttp3.Interceptor interceptor) Adds an optional interceptor to set in the OkHttp client.
abstract NbmapSpeech.Builder	language(java.lang.String language) Language of which to request the instructions be spoken.
abstract NbmapSpeech.Builder	networkInterceptor(okhttp3.Interceptor interceptor) Adds an optional network interceptor to set in the OkHttp client.
abstract NbmapSpeech.Builder	outputType(java.lang.String outputType) Output format for spoken instructions.
abstract NbmapSpeech.Builder	textType(java.lang.String textType) Format which the input is specified.

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

language

public abstract NbmapSpeech.Builder language(java.lang.String language)

Language of which to request the instructions be spoken. Default is "en-us"

Parameters:

language - as a string, i.e., "en-us"

Returns:

this builder for chaining options together

Since:

3.0.0

textType

public abstract NbmapSpeech.Builder textType(java.lang.String textType)

Format which the input is specified. If not specified, default is text

Parameters:

textType - either text or ssml

Returns:

this builder for chaining options together

Since:

3.0.0

outputType

public abstract NbmapSpeech.Builder outputType(java.lang.String outputType)

Output format for spoken instructions. If not specified, default is mp3

Parameters:

outputType - either mp3 or json

Returns:

this builder for chaining options together

Since:

3.0.0

accessToken

public abstract NbmapSpeech.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 in order to use the Optimization API

Returns:

this builder for chaining options together

Since:

3.0.0

instruction

public abstract NbmapSpeech.Builder instruction(@NonNull
                                                java.lang.String instruction)

Add the instruction text to dictate, either as plain text or ssml.

Parameters:

instruction - to dictate

Returns:

this builder for chaining options together

Since:

3.0.0

baseUrl

public abstract NbmapSpeech.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:

2.1.0

cache

public abstract NbmapSpeech.Builder cache(okhttp3.Cache cache)

Adds an optional cache to set in the OkHttp client.

Parameters:

cache - to set for OkHttp

Returns:

this builder for chaining options together

Since:

3.0.0

interceptor

public abstract NbmapSpeech.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 NbmapSpeech.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 NbmapSpeech build()

This uses the provided parameters set using the NbmapSpeech.Builder and first checks that all values are valid, formats the values as strings for easier consumption by the API, and lastly creates a new NbmapSpeech object with the values provided.

Returns:

a new instance of Nbmap Speech

Throws:

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

Since:

3.0.0