Package org.shakespeareframework.retrofit

Class CallHttpApis.Builder

java.lang.Object

org.shakespeareframework.retrofit.CallHttpApis.Builder

Enclosing class:

CallHttpApis

public static class CallHttpApis.Builder
extends java.lang.Object

Builder wrapping a Retrofit.Builder and a OkHttpClient.Builder to allow setting both with one class.

Method Summary

Modifier and Type	Method	Description
CallHttpApis.Builder	addConverterFactory(retrofit2.Converter.Factory converterFactory)	Adds the given Converter.Factory to the retrofitBuilder.
CallHttpApis.Builder	addInterceptor(okhttp3.Interceptor interceptor)	Adds the given Interceptor to the okHttpClientBuilder.
CallHttpApis.Builder	addJacksonConverterFactory()	Adds a JacksonConverterFactory to the retrofitBuilder.
CallHttpApis.Builder	addScalarsConverterFactory()	Adds a ScalarsConverterFactory to the retrofitBuilder.
CallHttpApis.Builder	authenticator(okhttp3.Authenticator authenticator)
CallHttpApis.Builder	baseUrl(java.lang.String baseUrl)	Sets the base URL to the retrofitBuilder.
<C> C	build(java.lang.Class<? extends C> clientClass)	Finalizes the build and returns the client.

Methods inherited from class java.lang.Object

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

Method Detail

baseUrl

public CallHttpApis.Builder baseUrl(java.lang.String baseUrl)

Sets the base URL to the retrofitBuilder.

Parameters:

baseUrl - base URL of the API

Returns:

the CallHttpApis.Builder

See Also:

Retrofit.Builder.baseUrl(String)

addConverterFactory

public CallHttpApis.Builder addConverterFactory(retrofit2.Converter.Factory converterFactory)

Adds the given Converter.Factory to the retrofitBuilder.

Parameters:

converterFactory - a Converter.Factory to be added to the retrofitBuilder

Returns:

the CallHttpApis.Builder

See Also:

Retrofit.Builder.addConverterFactory(Converter.Factory)

addScalarsConverterFactory

public CallHttpApis.Builder addScalarsConverterFactory()

Adds a ScalarsConverterFactory to the retrofitBuilder.

Returns:

the CallHttpApis.Builder

See Also:

addConverterFactory(Converter.Factory), ScalarsConverterFactory

addJacksonConverterFactory

public CallHttpApis.Builder addJacksonConverterFactory()

Adds a JacksonConverterFactory to the retrofitBuilder.

Returns:

the CallHttpApis.Builder

See Also:

addConverterFactory(Converter.Factory), JacksonConverterFactory

addInterceptor

public CallHttpApis.Builder addInterceptor(okhttp3.Interceptor interceptor)

Adds the given Interceptor to the okHttpClientBuilder.

Parameters:

interceptor - an Interceptor to be added to the okHttpClientBuilder

Returns:

the CallHttpApis.Builder

See Also:

OkHttpClient.Builder.addInterceptor(Interceptor)

authenticator

public CallHttpApis.Builder authenticator(okhttp3.Authenticator authenticator)

build

public <C> C build(java.lang.Class<? extends C> clientClass)

Finalizes the build and returns the client.

Type Parameters:

C - the type of the API client class

Parameters:

clientClass - the API client class

Returns:

an instance of clientClass to interact with the API

See Also:

Retrofit.Builder.build(), OkHttpClient.Builder.build(), Retrofit.create(Class)