Package io.openems.common.jsonrpc.base

Class JsonrpcResponse

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

Direct Known Subclasses:

JsonrpcResponseError, JsonrpcResponseSuccess

public abstract class JsonrpcResponse
extends JsonrpcMessage

Represents a JSON-RPC Response.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   ...
 }
 

See Also:

• JSON-RPC specification

Field Summary

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonrpcResponse(UUID id)

Method Summary

Modifier and Type	Method	Description
static JsonrpcResponse	from(com.google.gson.JsonObject j)	Parses a JsonObject to a JsonrpcResponse.
static JsonrpcResponse	from(String json)	Parses a JSON String to a JsonrpcResponse.
UUID	getId()
com.google.gson.JsonObject	toJsonObject()	Gets the JsonObject representation of this JsonrpcMessage.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

toString

Methods inherited from class java.lang.Object

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

Constructor Details

JsonrpcResponse

protected JsonrpcResponse(UUID id)

Method Details

from

public static JsonrpcResponse from(String json)
                            throws OpenemsError.OpenemsNamedException

Parses a JSON String to a JsonrpcResponse.

Parameters:

json - the JSON String

Returns:

the JsonrpcResponse

Throws:

OpenemsError.OpenemsNamedException - on error

from

public static JsonrpcResponse from(com.google.gson.JsonObject j)
                            throws OpenemsError.OpenemsNamedException

Parses a JsonObject to a JsonrpcResponse.

Parameters:

j - the JsonObject

Returns:

the JsonrpcResponse

Throws:

OpenemsError.OpenemsNamedException - on error

getId

public UUID getId()

toJsonObject

public com.google.gson.JsonObject toJsonObject()

Description copied from class: JsonrpcMessage

Gets the JsonObject representation of this JsonrpcMessage.

Overrides:

toJsonObject in class JsonrpcMessage

Returns:

a JsonObject