universum.studios.android.officium.service

Class ServiceError

java.lang.Object

universum.studios.android.officium.service.BaseServiceObject

universum.studios.android.officium.service.ServiceError

All Implemented Interfaces:

ServiceObject

public class ServiceError
extends BaseServiceObject

A BaseServiceObject implementation that represents an error occurred during service execution. Service error may be defined as error response send by the server where in such case the error/response code may be obtained via getErrorCode() along with the error body via getErrorBody() respectively. Or it may be defined as a failure that has caused the associated service and request to fail. In such case isFailure() will return true and the occurred failure may be obtained via getFailure().

Author:

Martin Albedinsky

Field Summary

Fields inherited from interface universum.studios.android.officium.service.ServiceObject

NO_REQUEST, NO_SERVICE

Constructor Summary

Constructors

Constructor and Description
ServiceError(int errorCode, ResponseBody errorBody) Creates a new instance of ServiceError with the specified errorCode and errorBody received from the server as error response for the associated service and request.
ServiceError(ServiceError other) Creates a new instance of ServiceError with data of the given one.
ServiceError(Throwable failure) Creates a new instance of ServiceError with the specified failure.

Method Summary

Modifier and Type	Method and Description
ResponseBody	getErrorBody() Returns the error body of the response send by the server as result to call to the associated service and request.
<T> T	getErrorBodyAs(Class<T> classOfT) Returns the error body of this service error as the desired type.
int	getErrorCode() Returns the error code of the response send by the server as result to call to the associated service and request.
Throwable	getFailure() Returns the failure that has caused the associated service and request to fail.
boolean	isError() Checks whether this service error represents an error response that has been received from the server for the associated service and request.
boolean	isFailure() Checks whether this service error represents a failure that has caused the associated service and request to fail during its execution.
void	setErrorBodyConverter(<any> converter) Sets a converter that should be used to covert error body of this service error to the desired object when getErrorBodyAs(Class) is called.
String	toString()

Methods inherited from class universum.studios.android.officium.service.BaseServiceObject

getRequestId, getServiceId, setRequestId, setServiceId

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceError

public ServiceError(int errorCode,
                    @NonNull
                    ResponseBody errorBody)

Creates a new instance of ServiceError with the specified errorCode and errorBody received from the server as error response for the associated service and request.

Parameters:

errorCode - The error/response code returned by the server.

errorBody - The body of error response returned by the server.

See Also:

getErrorCode(), getErrorBody()

ServiceError

public ServiceError(@NonNull
                    Throwable failure)

Creates a new instance of ServiceError with the specified failure.

Parameters:

failure - The failure that has caused the associated service and request to fail.

See Also:

isFailure(), getFailure()

ServiceError

public ServiceError(@NonNull
                    ServiceError other)

Creates a new instance of ServiceError with data of the given one.

Note, that this is same as creating shallow copy of the error object.

Parameters:

other - The other service error of which data to copy to the new one.

Method Detail

isError

public final boolean isError()

Checks whether this service error represents an error response that has been received from the server for the associated service and request.

Returns:

True if this error is an error response send by the server where the response code may be obtained via getErrorCode() and the error body via getErrorBody() respectively.

See Also:

isFailure()

getErrorCode

public int getErrorCode()

Returns the error code of the response send by the server as result to call to the associated service and request.

Returns:

Error code specified for this service error.

Throws:

NullPointerException - If this error is not an error response but a failure.

See Also:

getErrorBody()

getErrorBody

@NonNull
public ResponseBody getErrorBody()

Returns the error body of the response send by the server as result to call to the associated service and request.

Returns:

Error body specified for this service error.

Throws:

NullPointerException - If this error is not an error response but a failure.

See Also:

getErrorCode()

setErrorBodyConverter

public void setErrorBodyConverter(@Nullable
                                  <any> converter)

Sets a converter that should be used to covert error body of this service error to the desired object when getErrorBodyAs(Class) is called.

Parameters:

converter - The desired converter to be used for conversion. May be null to clear the current one.

getErrorBodyAs

@Nullable
public <T> T getErrorBodyAs(@NonNull
                                       Class<T> classOfT)

Returns the error body of this service error as the desired type.

Type Parameters:

T - The desired type as which to return error body or null if conversion fails.

Parameters:

classOfT - Class ot the type to which to convert the error body.

Returns:

Error body converted to the requested type.

Throws:

NullPointerException - If this error is not an error response but a failure.

NullPointerException - If no converter has been specified.

isFailure

public final boolean isFailure()

Checks whether this service error represents a failure that has caused the associated service and request to fail during its execution.

Returns:

True if this error is a failure that may be obtained via getFailure(), false if it is an error response.

See Also:

isError()

getFailure

@NonNull
public Throwable getFailure()

Returns the failure that has caused the associated service and request to fail.

Returns:

Throwable failure specified for this service error.

Throws:

NullPointerException - If this error is not a failure but an error response.

toString

public String toString()

Overrides:

toString in class Object