com.github.jinahya.jsonrpc.bind.v2

Interface JsonrpcMessage

All Superinterfaces:

JsonrpcObject

All Known Subinterfaces:

JsonrpcRequestMessage, JsonrpcResponseMessage

All Known Implementing Classes:

AbstractJsonrpcMessage, AbstractJsonrpcRequestMessage, AbstractJsonrpcResponseMessage

public interface JsonrpcMessage
extends JsonrpcObject

A base interface for JSON-RPC 2.0 messages.

Author:

Jin Kwon <onacit_at_gmail.com>

Method Summary

Modifier and Type	Method and Description
default Integer	getIdAsInteger() Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as an Integer value.
default Long	getIdAsLong() Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as a Long value.
BigInteger	getIdAsNumber() Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as a number.
String	getIdAsString() Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as a string.
@Pattern(regexp="2\\.0") @NotNull String	getJsonrpc() Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_JSONRPC property.
boolean	hasId() Indicates whether this message has a value for JsonrpcMessageConstants.PROPERTY_NAME_ID property.
@AssertTrue boolean	isIdContextuallyValid() Indicates whether current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property is contextually valid.
default void	setIdAsInteger(Integer id) Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.
default void	setIdAsLong(Long id) Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.
void	setIdAsNumber(BigInteger id) Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.
void	setIdAsString(String id) Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.
void	setJsonrpc(String jsonrpc) Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_JSONRPC property with specified value.

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

isContextuallyValid

Method Detail

getJsonrpc

@Pattern(regexp="2\\.0")
 @NotNull
@Pattern(regexp="2\\.0") @NotNull String getJsonrpc()

Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_JSONRPC property.

Returns:

current value of JsonrpcMessageConstants.PROPERTY_NAME_JSONRPC property.

setJsonrpc

void setJsonrpc(String jsonrpc)

Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_JSONRPC property with specified value.

Parameters:

jsonrpc - new value for JsonrpcMessageConstants.PROPERTY_NAME_JSONRPC property.

hasId

boolean hasId()

Indicates whether this message has a value for JsonrpcMessageConstants.PROPERTY_NAME_ID property.

Returns:

true if this message has a value for JsonrpcMessageConstants.PROPERTY_NAME_ID property; false otherwise.

Implementation Requirements:

When this method returns false any getIdAs...() method should return null.

isIdContextuallyValid

@AssertTrue
@AssertTrue boolean isIdContextuallyValid()

Indicates whether current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property is contextually valid.

Returns:

true if valid; false otherwise.

API Note:

It's considered to be valid if hasId() returns false.

getIdAsString

String getIdAsString()

Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as a string.

Returns:

current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property; null when hasId() returns false.

setIdAsString

void setIdAsString(String id)

Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.

Parameters:

id - new value for JsonrpcMessageConstants.PROPERTY_NAME_ID property.

getIdAsNumber

BigInteger getIdAsNumber()

Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as a number.

Returns:

current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property; null when hasId() returns false.

setIdAsNumber

void setIdAsNumber(BigInteger id)

Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.

Parameters:

id - new value for JsonrpcMessageConstants.PROPERTY_NAME_ID property.

getIdAsLong

default Long getIdAsLong()

Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as a Long value.

Returns:

current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property; null when hasId() returns false.

See Also:

getIdAsNumber(), BigInteger.longValueExact()

setIdAsLong

default void setIdAsLong(Long id)

Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.

Parameters:

id - new value for JsonrpcMessageConstants.PROPERTY_NAME_ID property.

See Also:

BigInteger.valueOf(long), setIdAsNumber(BigInteger)

getIdAsInteger

default Integer getIdAsInteger()

Returns current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property as an Integer value.

Returns:

current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property; null when hasId() returns false.

See Also:

getIdAsLong(), StrictMath.toIntExact(long)

setIdAsInteger

default void setIdAsInteger(Integer id)

Replaces current value of JsonrpcMessageConstants.PROPERTY_NAME_ID property with given value.

Parameters:

id - new value for JsonrpcMessageConstants.PROPERTY_NAME_ID property.

See Also:

Integer.longValue(), setIdAsLong(Long)