Package com.rubensgomes.base.reqresp

Class Error

java.lang.Object

com.rubensgomes.base.reqresp.Error

public class Error
extends Object

Error Object

A base type used to describe errors. This type may be used in error responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Error.ErrorBuilder
static class	Error.ErrorBuilderBase<T extends Error>

Constructor Summary

Constructors

Constructor	Description
Error()	No args constructor for use in serialization
Error(String errorMessage, Integer errorCode, String errorDescription, String errorNativeMessage)

Method Summary

Modifier and Type	Method	Description
static Error.ErrorBuilderBase	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Integer	getErrorCode()	The error code.
String	getErrorDescription()	The error code description.
String	getErrorMessage()	The general error message.
String	getErrorNativeMessage()	The root cause error message.
int	hashCode()
void	setAdditionalProperty(String name, Object value)
void	setErrorCode(Integer errorCode)	The error code.
void	setErrorDescription(String errorDescription)	The error code description.
void	setErrorMessage(String errorMessage)	The general error message.
void	setErrorNativeMessage(String errorNativeMessage)	The root cause error message.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Error

public Error()

No args constructor for use in serialization

Error

public Error(String errorMessage,
 Integer errorCode,
 String errorDescription,
 String errorNativeMessage)

Parameters:

errorDescription - The error code description.

errorMessage - The general error message.

errorNativeMessage - The root cause error message.

errorCode - The error code.

Method Details

builder

public static Error.ErrorBuilderBase builder()

getErrorMessage

public String getErrorMessage()

The general error message. (Required)

setErrorMessage

public void setErrorMessage(String errorMessage)

The general error message. (Required)

getErrorCode

public Integer getErrorCode()

The error code.

setErrorCode

public void setErrorCode(Integer errorCode)

The error code.

getErrorDescription

public String getErrorDescription()

The error code description.

setErrorDescription

public void setErrorDescription(String errorDescription)

The error code description.

getErrorNativeMessage

public String getErrorNativeMessage()

The root cause error message.

setErrorNativeMessage

public void setErrorNativeMessage(String errorNativeMessage)

The root cause error message.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
 Object value)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object