org.openkilda.messaging.error.ErrorData Class Reference

Inheritance diagram for org.openkilda.messaging.error.ErrorData:

Public Member Functions
	ErrorData (@JsonProperty("error-type") final ErrorType errorType, @JsonProperty("error-message") final String errorMessage, @JsonProperty("error-description") final String errorDescription)
ErrorType	getErrorType ()
void	setErrorType (final ErrorType errorType)
String	getErrorMessage ()
void	setErrorMessage (final String errorMessage)
String	getErrorDescription ()
void	setErrorDescription (final String errorDescription)
String	toString ()
boolean	equals (Object obj)
int	hashCode ()
Public Member Functions inherited from org.openkilda.messaging.MessageData
	MessageData (@JsonProperty(TIMESTAMP) final long timestamp)
	MessageData ()
Public Member Functions inherited from org.openkilda.messaging.BaseMessage
	BaseMessage (@JsonProperty(TIMESTAMP) final long timestamp)
	BaseMessage ()
long	getTimestamp ()
void	setTimestamp (long timestamp)

Protected Attributes
ErrorType	errorType
String	errorMessage
String	errorDescription
Protected Attributes inherited from org.openkilda.messaging.BaseMessage
long	timestamp = 0L

Additional Inherited Members
Static Public Member Functions inherited from org.openkilda.messaging.BaseMessage
static final< T extends BaseMessage > T	getMessage (String json, Class< T > type) throws java.io.IOException
static final< T extends BaseMessage > T	tryGetMessage (String json, Class< T > type)

Detailed Description

Defines the payload of a Message representing an error.

Definition at line 39 of file ErrorData.java.

Constructor & Destructor Documentation

ErrorData()

org.openkilda.messaging.error.ErrorData.ErrorData	(	@JsonProperty("error-type") final ErrorType	errorType,
		@JsonProperty("error-message") final String	errorMessage,
		@JsonProperty("error-description") final String	errorDescription
	)

Instance constructor.

Parameters

errorType	error type
errorMessage	error message
errorDescription	error exception

Definition at line 71 of file ErrorData.java.

Member Function Documentation

equals()

boolean org.openkilda.messaging.error.ErrorData.equals

(

Object

obj

)

Definition at line 149 of file ErrorData.java.

getErrorDescription()

String org.openkilda.messaging.error.ErrorData.getErrorDescription

(

)

Returns description of the error.

Returns

error description

Definition at line 120 of file ErrorData.java.

getErrorMessage()

String org.openkilda.messaging.error.ErrorData.getErrorMessage

(

)

Returns error message.

Returns

error message

Definition at line 102 of file ErrorData.java.

getErrorType()

ErrorType org.openkilda.messaging.error.ErrorData.getErrorType

(

)

Returns error type.

Returns

error type

Definition at line 84 of file ErrorData.java.

hashCode()

int org.openkilda.messaging.error.ErrorData.hashCode

(

)

Definition at line 168 of file ErrorData.java.

setErrorDescription()

void org.openkilda.messaging.error.ErrorData.setErrorDescription

(

final String

errorDescription

)

Sets error description.

Parameters

errorDescription

exception description

Definition at line 129 of file ErrorData.java.

setErrorMessage()

void org.openkilda.messaging.error.ErrorData.setErrorMessage

(

final String

errorMessage

)

Sets error message.

Parameters

errorMessage

error message

Definition at line 111 of file ErrorData.java.

setErrorType()

void org.openkilda.messaging.error.ErrorData.setErrorType

(

final ErrorType

errorType

)

Sets error type.

Parameters

errorType

error type

Definition at line 93 of file ErrorData.java.

toString()

String org.openkilda.messaging.error.ErrorData.toString

(

)

Definition at line 137 of file ErrorData.java.

Member Data Documentation

errorDescription

String org.openkilda.messaging.error.ErrorData.errorDescription

protected

Error description.

Definition at line 61 of file ErrorData.java.

errorMessage

String org.openkilda.messaging.error.ErrorData.errorMessage

protected

Error message.

Definition at line 55 of file ErrorData.java.

errorType

ErrorType org.openkilda.messaging.error.ErrorData.errorType

protected

Error type.

Definition at line 49 of file ErrorData.java.

---

The documentation for this class was generated from the following file:

• /Users/kevin/Desktop/Kilda/open-kilda-develop/services/src/messaging/src/main/java/org/openkilda/messaging/error/ErrorData.java