universum.studios.android.officium.service

Class ErrorResponse

java.lang.Object

universum.studios.android.officium.service.BaseServiceObject

universum.studios.android.officium.service.ServiceResponse

universum.studios.android.officium.service.ErrorResponse

All Implemented Interfaces:

ServiceObject

public class ErrorResponse
extends ServiceResponse

A ServiceResponse that may be used to parse body of response send by a server that contains an ErrorResponse.Error object.

Response body

 {
     "error": {
         "code": 486,
         "message": "Item not found on the server!"
     }
 }
 

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorResponse.Error Simple error object that can hold two attributes: Error#code and Error#message.

Field Summary

Fields

Modifier and Type	Field and Description
ErrorResponse.Error	error Error specified for this response during its initialization or parsed using Gson.

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

NO_REQUEST, NO_SERVICE

Constructor Summary

Constructors

Constructor and Description
ErrorResponse() Creates a new instance of ErrorResponse without error.
ErrorResponse(ErrorResponse.Error error) Creates a new instance of ErrorResponse with the specified error.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns the code of the error (if any) of this response.
String	getErrorMessage() Returns the message of the error (if any) of this response.
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

Field Detail

error

public ErrorResponse.Error error

Error specified for this response during its initialization or parsed using Gson.

Constructor Detail

ErrorResponse

public ErrorResponse()

Creates a new instance of ErrorResponse without error.

This constructor should be used only by Gson library.

ErrorResponse

public ErrorResponse(@NonNull
                     ErrorResponse.Error error)

Creates a new instance of ErrorResponse with the specified error.

Parameters:

error - The error for the new error response.

Method Detail

getErrorCode

public int getErrorCode()

Returns the code of the error (if any) of this response.

Returns:

Error code or 0 if there is no error presented.

getErrorMessage

@NonNull
public String getErrorMessage()

Returns the message of the error (if any) of this response.

Returns:

Error message or "" if there is no error presented.

toString

public String toString()

Overrides:

toString in class Object