com.github.jinahya.jsonrpc.bind.v2

Interface JsonrpcResponseMessageError

All Superinterfaces:

JsonrpcObject

All Known Implementing Classes:

AbstractJsonrpcResponseMessageError

public interface JsonrpcResponseMessageError
extends JsonrpcObject

An interface for JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property of JSON-RPC 2.0 response messages.

Author:

Jin Kwon <onacit_at_gmail.com>

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property.
<T> List<T>	getDataAsArray(Class<T> elementClass) Reads current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property as a list of specified element type.
<T> T	getDataAsObject(Class<T> objectClass) Reads current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property as an instance of specified class.
@NotNull String	getMessage() Returns current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_MESSAGE property.
boolean	hasData() Indicates this error object has a value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property.
default boolean	isCodeForImplementationDefinedServerErrors() Indicates that current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property is between JsonrpcResponseMessageErrorConstants.CODE_SERVER_ERROR_MIN and JsonrpcResponseMessageErrorConstants.CODE_SERVER_ERROR_MAX, both inclusive.
default boolean	isCodeReservedForPredefinedErrors() Indicates that current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property is between JsonrpcResponseMessageErrorConstants.CODE_RESERVED_FOR_PREDEFINED_ERRORS_MIN and JsonrpcResponseMessageErrorConstants.CODE_RESERVED_FOR_PREDEFINED_ERRORS_MAX, both inclusive.
default @AssertTrue boolean	isDataContextuallyValid() Indicates the value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property is contextually valid.
static JsonrpcResponseMessageError	newInstance() Creates a new instance.
void	setCode(int code) Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property with specified value.
void	setDataAsArray(List<?> data) Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property with specified list.
void	setDataAsObject(Object data) Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property with specified object.
void	setMessage(String message) Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_MESSAGE property with specified value.

Methods inherited from interface com.github.jinahya.jsonrpc.bind.v2.JsonrpcObject

isContextuallyValid

Method Detail

newInstance

static JsonrpcResponseMessageError newInstance()

Creates a new instance.

Returns:

a new instance.

getCode

int getCode()

Returns current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property.

Returns:

current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property

setCode

void setCode(int code)

Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property with specified value.

Parameters:

code - new value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property.

isCodeReservedForPredefinedErrors

default boolean isCodeReservedForPredefinedErrors()

Indicates that current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property is between JsonrpcResponseMessageErrorConstants.CODE_RESERVED_FOR_PREDEFINED_ERRORS_MIN and JsonrpcResponseMessageErrorConstants.CODE_RESERVED_FOR_PREDEFINED_ERRORS_MAX, both inclusive.

Returns:

true if current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property is in a range of reserved for predefined values; false otherwise.

isCodeForImplementationDefinedServerErrors

default boolean isCodeForImplementationDefinedServerErrors()

Indicates that current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property is between JsonrpcResponseMessageErrorConstants.CODE_SERVER_ERROR_MIN and JsonrpcResponseMessageErrorConstants.CODE_SERVER_ERROR_MAX, both inclusive.

Returns:

true if current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_CODE property means a server error; false otherwise.

getMessage

@NotNull
@NotNull String getMessage()

Returns current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_MESSAGE property.

Returns:

current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_MESSAGE property

setMessage

void setMessage(String message)

Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_MESSAGE property with specified value.

Parameters:

message - new value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_MESSAGE property.

hasData

boolean hasData()

Indicates this error object has a value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property.

Returns:

true if this error object has a value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property; false otherwise.

isDataContextuallyValid

@AssertTrue
default @AssertTrue boolean isDataContextuallyValid()

Indicates the value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property is contextually valid.

Returns:

true if current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property is contextually valid; false otherwise.

API Note:

It's considered to be valid when hasData() returns false.

Implementation Requirements:

The default implementation returns true.

getDataAsArray

<T> List<T> getDataAsArray(Class<T> elementClass)

Reads current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property as a list of specified element type.

Type Parameters:

T - element type parameter

Parameters:

elementClass - the element type.

Returns:

a list of elementClass.

setDataAsArray

void setDataAsArray(List<?> data)

Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property with specified list.

Parameters:

data - new value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property.

getDataAsObject

<T> T getDataAsObject(Class<T> objectClass)

Reads current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property as an instance of specified class.

Type Parameters:

T - object type parameter

Parameters:

objectClass - the class of the value.

Returns:

an instance of objectClass.

setDataAsObject

void setDataAsObject(Object data)

Replaces current value of JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property with specified object.

Parameters:

data - new value for JsonrpcResponseMessageErrorConstants.PROPERTY_NAME_DATA property.