com.pcloud.networking.api

Class ApiComposer.Builder

java.lang.Object

com.pcloud.networking.api.ApiComposer.Builder

Enclosing class:

ApiComposer

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

A builder to build instances of ApiComposer

Method Summary

Modifier and Type	Method and Description
ApiComposer.Builder	addAdapterFactories(CallAdapter.Factory... adapterFactories) Adds an array of CallAdapter.Factory objects for the ApiComposer.Builder
ApiComposer.Builder	addAdapterFactories(java.lang.Iterable<CallAdapter.Factory> adapterFactories) Adds a Collection of CallAdapter.Factory objects for the ApiComposer.Builder
ApiComposer.Builder	addAdapterFactory(CallAdapter.Factory adapterFactory) Sets a single CallAdapter.Factory for this ApiComposer
ApiComposer.Builder	addInterceptor(ResponseInterceptor interceptor) Sets a single ResponseInterceptor for this ApiComposer
ApiComposer.Builder	addInterceptors(java.util.Collection<ResponseInterceptor> interceptors) Adds a Collection of ResponseInterceptor objects for the ApiComposer.Builder
ApiComposer.Builder	apiClient(PCloudAPIClient apiClient) Sets the PCloudAPIClient for the ApiComposer
ApiComposer	create() Creates and returns a new instance of the ApiComposer with the parameters set via the ApiComposer.Builder
ApiComposer.Builder	loadEagerly(boolean loadEagerly) Determine if the interface implementation will be lazy or eager.
ApiComposer.Builder	removeInterceptor(ResponseInterceptor interceptor) Removes a single ResponseInterceptor from the ApiComposer.Builder
ApiComposer.Builder	removeInterceptors(java.util.Collection<ResponseInterceptor> interceptors) Removes a Collection of ResponseInterceptor from the ApiComposer.Builder
ApiComposer.Builder	transformer(Transformer transformer) Sets the Transformer for this ApiComposer

Methods inherited from class java.lang.Object

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

Method Detail

apiClient

public ApiComposer.Builder apiClient(PCloudAPIClient apiClient)

Sets the PCloudAPIClient for the ApiComposer

Parameters:

apiClient - The PCloudAPIClient to be set to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

Throws:

java.lang.IllegalArgumentException - on a null PCloudAPIClient argument

transformer

public ApiComposer.Builder transformer(Transformer transformer)

Sets the Transformer for this ApiComposer

Parameters:

transformer - The Transformer to be set to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

Throws:

java.lang.IllegalArgumentException - on a null Transformer argument

addInterceptor

public ApiComposer.Builder addInterceptor(ResponseInterceptor interceptor)

Sets a single ResponseInterceptor for this ApiComposer

Parameters:

interceptor - The ResponseInterceptor to be set to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

Throws:

java.lang.IllegalArgumentException - on a null ResponseInterceptor argument

removeInterceptor

public ApiComposer.Builder removeInterceptor(ResponseInterceptor interceptor)

Removes a single ResponseInterceptor from the ApiComposer.Builder

Parameters:

interceptor - The ResponseInterceptor to be removed from the ApiComposer.Builder

Returns:

A reference to the ApiComposer.Builder object

Throws:

java.lang.IllegalArgumentException - on a null ResponseInterceptor argument

removeInterceptors

public ApiComposer.Builder removeInterceptors(java.util.Collection<ResponseInterceptor> interceptors)

Removes a Collection of ResponseInterceptor from the ApiComposer.Builder

Does the same thing as removeInterceptor(ResponseInterceptor) for each ResponseInterceptor in the Collection

Parameters:

interceptors - A Collection of ResponseInterceptor objects to be removed from the ApiComposer.Builder

Returns:

A reference to the ApiComposer.Builder object

Throws:

java.lang.IllegalArgumentException - on a null Collection argument

addInterceptors

public ApiComposer.Builder addInterceptors(java.util.Collection<ResponseInterceptor> interceptors)

Adds a Collection of ResponseInterceptor objects for the ApiComposer.Builder

Does the same thing as addInterceptor(ResponseInterceptor) for each ResponseInterceptor in the Collection

Parameters:

interceptors - A Collection of ResponseInterceptor objects to be added to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

addAdapterFactory

public ApiComposer.Builder addAdapterFactory(CallAdapter.Factory adapterFactory)

Sets a single CallAdapter.Factory for this ApiComposer

Parameters:

adapterFactory - The CallAdapter.Factory to be set to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

Throws:

java.lang.IllegalArgumentException - on a null CallAdapter.Factory argument

addAdapterFactories

public ApiComposer.Builder addAdapterFactories(CallAdapter.Factory... adapterFactories)

Adds an array of CallAdapter.Factory objects for the ApiComposer.Builder

Does the same thing as addAdapterFactory(CallAdapter.Factory) for each CallAdapter.Factory in the Collection

Parameters:

adapterFactories - An array of CallAdapter.Factory objects to be added to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

addAdapterFactories

public ApiComposer.Builder addAdapterFactories(java.lang.Iterable<CallAdapter.Factory> adapterFactories)

Adds a Collection of CallAdapter.Factory objects for the ApiComposer.Builder

Does the same thing as addAdapterFactory(CallAdapter.Factory) for each CallAdapter.Factory in the Collection

Parameters:

adapterFactories - A Collection of CallAdapter.Factory objects to be added to the ApiComposer

Returns:

A reference to the ApiComposer.Builder object

loadEagerly

public ApiComposer.Builder loadEagerly(boolean loadEagerly)

Determine if the interface implementation will be lazy or eager.

If set to true the ApiComposer created from this builder will initialize all interface method implementations immediately after the ApiComposer.compose(Class) is called.

If set to false the ApiComposer.compose(Class) will only basic conditions for the supplied interface class and will actually resolve the interface method implementations on-demand (when the methods are called for the first time).

Parameters:

loadEagerly - the condition for whether the interface implementation should be lazy or eager

Returns:

A reference to the ApiComposer.Builder object

create

public ApiComposer create()

Creates and returns a new instance of the ApiComposer with the parameters set via the ApiComposer.Builder

Returns:

A new instance of the ApiComposer with the parameters set via the ApiComposer.Builder