universum.studios.android.officium.service

Class ServiceCall<T>

java.lang.Object

universum.studios.android.officium.service.ServiceCall<T>

public class ServiceCall<T>
extends Object

A Call implementation that wraps original Retrofit call to provide functionality that supports association of ServiceCallback with the related service along with service request.

Each instance of service call need to be created with the original call via #ServiceCall(Call) constructor along with id of the corresponding service via withServiceId(int). The provided service id is than attached to the callback when enqueue(ServiceCallback) is called along with the request id which this method returns. Subclasses may implement requestId() to generate custom unique id for a specific request. In such case, do not forget to properly override also clone() method.

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
ServiceCall(<any> call) Creates a new instance of ServiceCall with the given original Retrofit call.

Method Summary

Modifier and Type	Method and Description
void	cancel()
<any>	clone() Creates a new clone of this service call with the original Retrofit call also cloned and with the same service id as specified via withServiceId(int) (if any).
void	enqueue(<any> callback)
String	enqueue(ServiceCallback<T> callback) Like #enqueue(Callback), but this method also obtains and returns unique id of this asynchronous request so it may be later identified through the associated service objects: ServiceCallback which results to either ServiceResponse or ServiceError.
<any>	execute()
boolean	isCanceled()
boolean	isExecuted()
Request	request()
protected String	requestId() Called to obtain a unique id for the current service request that has been requested to be executed asynchronously via enqueue(ServiceCallback).
ServiceCall<T>	withServiceId(int serviceId) Specifies id of the service to be this call associated with.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceCall

public ServiceCall(@NonNull
                   <any> call)

Creates a new instance of ServiceCall with the given original Retrofit call.

Parameters:

call - The Retrofit call to which will be this service call delegating its methods.

Method Detail

withServiceId

public ServiceCall<T> withServiceId(int serviceId)

Specifies id of the service to be this call associated with. The provided id will be also attached to the ServiceCallback when enqueue(ServiceCallback) is called and the callback does not have service id attached yet.

Parameters:

serviceId - Id of the desired service to be this call associated with.

Returns:

This service call to allow methods chaining.

Throws:

UnsupportedOperationException - If service id for this call has been already specified.

execute

public <any> execute()
              throws IOException

Throws:

IOException

enqueue

@NonNull
public String enqueue(@NonNull
                                ServiceCallback<T> callback)

Like #enqueue(Callback), but this method also obtains and returns unique id of this asynchronous request so it may be later identified through the associated service objects: ServiceCallback which results to either ServiceResponse or ServiceError.

Also id of the service specified for this service call will be attached to the callback if it has no service id attached yet.

Parameters:

callback - The desired callback that should be notified when service requests is finished.

Returns:

Unique id of this request for later identification of received callback, either successful response or error.

See Also:

ServiceObject.getServiceId(), ServiceObject.getRequestId()

requestId

@NonNull
protected String requestId()

Called to obtain a unique id for the current service request that has been requested to be executed asynchronously via enqueue(ServiceCallback).

This implementation returns a string representation of the current time in milliseconds as Long.toString(System.currentTimeMillis()).

Returns:

Unique id for the current request that will be attached to the service callback.

enqueue

public void enqueue(<any> callback)

isExecuted

public boolean isExecuted()

cancel

public void cancel()

isCanceled

public boolean isCanceled()

request

public Request request()

clone

public <any> clone()

Creates a new clone of this service call with the original Retrofit call also cloned and with the same service id as specified via withServiceId(int) (if any).

Overrides:

clone in class Object