universum.studios.android.officium.service

Class ServiceManager.ServicesConfiguration<S>

java.lang.Object

universum.studios.android.officium.service.ServiceManager.ServicesConfiguration<S>

Type Parameters:

S - Type of the services interface specific for this configuration.

Enclosing class:

ServiceManager

public static final class ServiceManager.ServicesConfiguration<S>
extends Object

Class used for configuration of a specific Retrofit services interface. Each configuration object manages a single instance of Retrofit along with its corresponding Retrofit.Builder that are used to build a PROXY instance for services interface for the current configuration.

Created instance of services PROXY is cached so it does not need to be created each time it is requested via ServiceManager.services(Class). This instance of PROXY is re-created only in case where there has been performed some configuration change and invalidate() has been called to indicate the services PROXY is no longer valid.

Method Summary

Modifier and Type	Method and Description
void	invalidate() Invalidates the current configuration.
Retrofit	retrofit() Returns the Retrofit instance for the current configuration.
Retrofit.Builder	retrofitBuilder() Returns the Retrofit builder that is used to build instance of Retrofit and instance of services PROXY for this services configuration.

Methods inherited from class java.lang.Object

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

Method Detail

retrofitBuilder

@NonNull
public Retrofit.Builder retrofitBuilder()

Returns the Retrofit builder that is used to build instance of Retrofit and instance of services PROXY for this services configuration.

When any of the current parameters of the builder is changed do not forget to call invalidate() so the change is accepted and new updated services PROXY is created in next call to ServiceManager.services(Class).

Returns:

Retrofit builder that may be used to configure services PROXY associated with this configuration and may be obtained via ServiceManager.services(Class).

invalidate

public void invalidate()

Invalidates the current configuration. Next call to ServiceManager.services(Class) with services interface associated with this configuration will create a new instance of the desired services PROXY.

retrofit

@NonNull
public Retrofit retrofit()

Returns the Retrofit instance for the current configuration.

Returns:

Retrofit instance.

See Also:

retrofitBuilder(), invalidate()