com.github.jinahya.jsonrpc.bind.v2

Class ResponseObject<IdType,ResultType,ErrorType extends ResponseObject.ErrorObject<?>>

java.lang.Object

com.github.jinahya.jsonrpc.bind.v2.JsonrpcObject<IdType>

com.github.jinahya.jsonrpc.bind.v2.ResponseObject<IdType,ResultType,ErrorType>

Type Parameters:

ResultType - result type parameter

ErrorType - error type parameter

public class ResponseObject<IdType,ResultType,ErrorType extends ResponseObject.ErrorObject<?>>
extends JsonrpcObject<IdType>

Represents response objects.

See Also:

5. Response Object (JSON-RPC 2.0 Specification)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseObject.ErrorObject<DataType> Represents error objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_NAME_ERROR The property name for error.
static String	PROPERTY_NAME_RESULT The property name for result.

Fields inherited from class com.github.jinahya.jsonrpc.bind.v2.JsonrpcObject

PROPERTY_NAME_ID, PROPERTY_NAME_JSONRPC, PROPERTY_VALUE_JSONRPC

Constructor Summary

Constructors

Constructor and Description
ResponseObject()

Method Summary

Modifier and Type	Method and Description
ErrorType	getError() Returns the current value of "error" property.
ResultType	getResult() Returns the current value of "result" property.
void	setError(ErrorType error) Replaces the current value of "error" property with given.
void	setErrorExclusively(ErrorType error) Sets the current value of "error" property exclusively.
void	setResult(ResultType result) Replaces the current value of "result" property with given.
void	setResultExclusively(ResultType result) Sets the current value of "result" property exclusively.
String	toString() Returns a string representation of the object.

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

getId, getJsonrpc, setId, setJsonrpc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_NAME_RESULT

public static final String PROPERTY_NAME_RESULT

The property name for result.

See Also:

Constant Field Values

PROPERTY_NAME_ERROR

public static final String PROPERTY_NAME_ERROR

The property name for error.

See Also:

Constant Field Values

Constructor Detail

ResponseObject

public ResponseObject()

Method Detail

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class JsonrpcObject<IdType>

Returns:

a string representation of the object.

getResult

public ResultType getResult()

Returns the current value of "result" property.

Returns:

the current value of "result" property.

setResult

public void setResult(ResultType result)

Replaces the current value of "result" property with given.

Parameters:

result - new value for "result" property.

setResultExclusively

public void setResultExclusively(ResultType result)

Sets the current value of "result" property exclusively. This method, if given result argument is not null, sets "error" property with null.

Parameters:

result - new value for "result" property.

getError

public ErrorType getError()

Returns the current value of "error" property.

Returns:

the current value of "error" property.

setError

public void setError(ErrorType error)

Replaces the current value of "error" property with given.

Parameters:

error - new value for "error" property.

setErrorExclusively

public void setErrorExclusively(ErrorType error)

Sets the current value of "error" property exclusively. This method, if given error argument is not null, sets "result" property with null.

Parameters:

error - new value for "error" property.