Package io.openems.common.jsonrpc.base

Class JsonrpcMessage

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

Direct Known Subclasses:

AbstractJsonrpcRequest, JsonrpcResponse

public abstract class JsonrpcMessage
extends Object

Represents a JSON-RPC Message.

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

See Also:

• JSON-RPC specification

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
JsonrpcMessage()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

JSONRPC_VERSION

public static final String JSONRPC_VERSION

See Also:

• Constant Field Values

Constructor Details

JsonrpcMessage

public JsonrpcMessage()

Method Details

from

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

Parses a JSON String to a JsonrpcMessage.

Parameters:

json - the JSON String

Returns:

the JsonrpcMessage

Throws:

OpenemsError.OpenemsNamedException - on error

from

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

Parses a JsonObject to a JsonrpcMessage.

Parameters:

j - the JsonObject

Returns:

the JsonrpcMessage

Throws:

OpenemsError.OpenemsNamedException - on error

toJsonObject

public com.google.gson.JsonObject toJsonObject()

Gets the JsonObject representation of this JsonrpcMessage.

Returns:

a JsonObject

toString

public String toString()

Returns this JsonrpcMessage as a JSON String.

Overrides:

toString in class Object