com.github.jinahya.jsonrpc.bind.v2

Interface JsonrpcResponseMessage

All Superinterfaces:

JsonrpcMessage, JsonrpcObject

All Known Implementing Classes:

AbstractJsonrpcResponseMessage

public interface JsonrpcResponseMessage
extends JsonrpcMessage

An interface for JSON-RPC 2.0 response messages.

Author:

Jin Kwon <onacit_at_gmail.com>

See Also:

Response Object (JSON-RPC 2.0)

Method Summary

Modifier and Type	Method and Description
static JsonrpcResponseMessage	fromJson(Object source) Reads an instance from specified source.
JsonrpcResponseMessageError	getErrorAs() Returns current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property.
<T> List<T>	getResultAsArray(Class<T> elementClass) Returns current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property as a list of specified element class.
<T> T	getResultAsObject(Class<T> objectClass) Returns current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property as an instance of specified object class.
boolean	hasError() Indicates this message has a value for JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property.
boolean	hasResult() Indicates this message has a value for JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property.
default @AssertTrue boolean	isErrorContextuallyValid() Indicates that current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property is contextually valid.
default @AssertTrue boolean	isResultAndErrorExclusive() Indicates whether JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property and the JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property are set exclusively.
default @AssertTrue boolean	isResultContextuallyValid() Indicates current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property is contextually valid.
static JsonrpcResponseMessage	newInstance() Returns a new instance.
void	setErrorAs(JsonrpcResponseMessageError error) Replaces current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property with specified value.
void	setResultAsArray(List<?> result) Replaces current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property with specified value.
void	setResultAsObject(Object result) Replaces current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property with specified value.
default String	toJson() Returns a JSON representation of this message.
default void	toJson(Object target) Writes this message to specified target.

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

getIdAsInteger, getIdAsLong, getIdAsNumber, getIdAsString, getJsonrpc, hasId, isIdContextuallyValid, setIdAsInteger, setIdAsLong, setIdAsNumber, setIdAsString, setJsonrpc

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

isContextuallyValid

Method Detail

newInstance

static JsonrpcResponseMessage newInstance()

Returns a new instance.

Returns:

a new instance.

fromJson

static JsonrpcResponseMessage fromJson(Object source)

Reads an instance from specified source.

Parameters:

source - the source from which the new instance is read.

Returns:

a new instance read from source.

toJson

default void toJson(Object target)

Writes this message to specified target.

Parameters:

target - the target to which the message is written.

toJson

default String toJson()

Returns a JSON representation of this message.

Returns:

a JSON representation of this message.

isResultAndErrorExclusive

@AssertTrue
default @AssertTrue boolean isResultAndErrorExclusive()

Indicates whether JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property and the JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property are set exclusively.

Returns:

true if the JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property and the JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property are exclusively set; false otherwise.

Implementation Requirements:

The default implementation returns an XOR-ed value of hasResult() and hasError().

hasResult

boolean hasResult()

Indicates this message has a value for JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property.

Returns:

true if this message has a value for JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property; false otherwise.

Implementation Requirements:

Then this method returns false any getResultAs...() method should return null.

isResultContextuallyValid

@AssertTrue
default @AssertTrue boolean isResultContextuallyValid()

Indicates current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property is contextually valid.

Returns:

true if current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property is contextually valid; false otherwise.

Implementation Requirements:

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

Implementation Note:

The default implementation returns true.

getResultAsArray

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

Returns current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property as a list of specified element class.

Type Parameters:

T - element type parameter

Parameters:

elementClass - the element class.

Returns:

a list of elementClass; null when hasResult() method returns false.

setResultAsArray

void setResultAsArray(List<?> result)

Replaces current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property with specified value.

Parameters:

result - new value for JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property.

getResultAsObject

<T> T getResultAsObject(Class<T> objectClass)

Returns current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property as an instance of specified object class.

Type Parameters:

T - object type parameter.

Parameters:

objectClass - the object class.

Returns:

an instance of objectClass; null when hasResult() method returns false.

setResultAsObject

void setResultAsObject(Object result)

Replaces current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property with specified value.

Parameters:

result - new value for JsonrpcResponseMessageConstants.PROPERTY_NAME_RESULT property.

hasError

boolean hasError()

Indicates this message has a value for JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property.

Returns:

true if this message has a value for JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property; false otherwise.

Implementation Requirements:

Then this method returns false any getErrorAs...() method should return null.

isErrorContextuallyValid

@AssertTrue
default @AssertTrue boolean isErrorContextuallyValid()

Indicates that current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property is contextually valid.

Returns:

true if current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property is contextually valid; false otherwise.

Implementation Requirements:

It's considered to be contextually valid when hasError() method returns false.

Implementation Note:

Default implementation returns true.

getErrorAs

JsonrpcResponseMessageError getErrorAs()

Returns current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property.

Returns:

current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property; null when hasError() method returns false.

setErrorAs

void setErrorAs(JsonrpcResponseMessageError error)

Replaces current value of JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property with specified value.

Parameters:

error - new value for JsonrpcResponseMessageConstants.PROPERTY_NAME_ERROR property.