com.pcloud.networking.api

Class ApiComposer

java.lang.Object

com.pcloud.networking.api.ApiComposer

public class ApiComposer
extends java.lang.Object

Composes implementations for interfaces in which you have provided methods that describe your network calls

See Also:

PCloudAPIClient, ResponseInterceptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiComposer.Builder A builder to build instances of ApiComposer

Method Summary

Modifier and Type	Method and Description
PCloudAPIClient	apiClient() Returns the PCloudAPIClient you provided in the ApiComposer.Builder
<T> T	compose(java.lang.Class<T> apiType) Composes an instance of the java interface which houses the network call methods
static ApiComposer.Builder	create() Creates and returns a ApiComposer.Builder to build the ApiComposer with
java.util.List<ResponseInterceptor>	interceptors() Returns a List of all the ResponseInterceptor objects you provided in the ApiComposer.Builder
ApiComposer.Builder	newBuilder() Returns a new instance of a ApiComposer.Builder to build a new ApiComposer
Transformer	transformer() Returns the Transformer you provided in the ApiComposer.Builder

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ApiComposer.Builder create()

Creates and returns a ApiComposer.Builder to build the ApiComposer with

Returns:

A new instance of a ApiComposer.Builder to build the ApiComposer with

transformer

public Transformer transformer()

Returns the Transformer you provided in the ApiComposer.Builder

Returns:

The Transformer you provided in the ApiComposer.Builder

apiClient

public PCloudAPIClient apiClient()

Returns the PCloudAPIClient you provided in the ApiComposer.Builder

Returns:

The PCloudAPIClient you provided in the ApiComposer.Builder

interceptors

public java.util.List<ResponseInterceptor> interceptors()

Returns a List of all the ResponseInterceptor objects you provided in the ApiComposer.Builder

Returns:

A List of all the ResponseInterceptor objects you provided in the ApiComposer.Builder

compose

public <T> T compose(java.lang.Class<T> apiType)

Composes an instance of the java interface which houses the network call methods

Note that you should provide an interface which does not extend anything or else this wont work!

Type Parameters:

T - The generic type of the returned instance

Parameters:

apiType - The class of the java interface in which you have written the methods to represent the network calls

Returns:

An instance of a class of the same generic type as the class you provided as an argument implementing the interface in which you have written methods to represent your network calls

Throws:

java.lang.RuntimeException - if loadEagerly is set to true and if the instantiation fails

newBuilder

public ApiComposer.Builder newBuilder()

Returns a new instance of a ApiComposer.Builder to build a new ApiComposer

Returns:

A new instance of a ApiComposer.Builder to build a new ApiComposer