Package eliasstar.jsonrpc.objects

Class Request

java.lang.Object

eliasstar.jsonrpc.objects.Request

Direct Known Subclasses:

Notification

public class Request
extends Object

Represents a JSON-RPC request.

Since:

0.1.0

Author:

Elias*

See Also:

JSON-RPC Specification

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Request(Id<?> id, String method, Parameters<?> params)	Creates a Request.
	Request(Number id, String method)	Creates a Request without parameters.
	Request(Number id, String method, com.google.gson.JsonArray params)	Creates a Request with parameters in array format.
	Request(Number id, String method, com.google.gson.JsonObject params)	Creates a Request with parameters in object format.
	Request(String id, String method)	Creates a Request without parameters.
	Request(String id, String method, com.google.gson.JsonArray params)	Creates a Request with parameters in array format.
	Request(String id, String method, com.google.gson.JsonObject params)	Creates a Request with parameters in object format.

Method Summary

Modifier and Type	Method	Description
protected String	contentAsJsonString()	The returned String represents the contents of this Request.
boolean	equals(Object obj)	This method returns true if the argument is a Request and all properties are equal, otherwise returns false.
int	hashCode()	This method is implemented using Objects.hash().
Optional<Id<?>>	id()	Getter for id field.
String	jsonrpc()	Getter for jsonrpc field.
String	method()	Getter for method field.
Optional<Parameters<?>>	params()	Getter for params field.
String	toString()	The returned String is equal to the value of: "Request@" + Integer.toHexString(hashCode()) + " " + contentAsJsonString() where contentAsJsonString() returns a JSON-like String of this Request.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Request

protected Request(Id<?> id,
                  String method,
                  Parameters<?> params)

Creates a Request.

Parameters:

id - If null the Request is considered to be a Notification

method - Must not be null

params - If null the Request has no params

Request

public Request(String id,
               String method)

Creates a Request without parameters.

If id is null the request id will be serialized as the JSON null value. If you want to omit the id, you should create a Notification.

Parameters:

id - A id of type String or null

method - The non-null method you want to invoke

Request

public Request(String id,
               String method,
               com.google.gson.JsonArray params)

Creates a Request with parameters in array format.

If id is null the request id will be serialized as the JSON null value. If you want to omit the id you should create a Notification.

If params is null a NullPointerException will be thrown. If you want to create a request without parameters, you should use Request(String, String)

Parameters:

id - A id of type String or null

method - The non-null method you want to invoke

params - The parameters provided as JsonArray

Request

public Request(String id,
               String method,
               com.google.gson.JsonObject params)

Creates a Request with parameters in object format.

If id is null the request id will be serialized as the JSON null value. If you want to omit the id you should create a Notification.

If params is null a NullPointerException will be thrown. If you want to create a request without parameters, you should use Request(String, String)

Parameters:

id - A id of type String or null

method - The non-null method you want to invoke

params - The parameters provided as JsonObject

Request

public Request(Number id,
               String method)

Creates a Request without parameters.

If id is null the request id will be serialized as the JSON null value. If you want to omit the id, you should create a Notification.

Parameters:

id - A id of type Number or null

method - The non-null method you want to invoke

Request

public Request(Number id,
               String method,
               com.google.gson.JsonArray params)

Creates a Request with parameters in array format.

If id is null the request id will be serialized as the JSON null value. If you want to omit the id you should create a Notification.

If params is null a NullPointerException will be thrown. If you want to create a request without parameters, you should use Request(Number, String)

Parameters:

id - A id of type Number or null

method - The non-null method you want to invoke

params - The parameters provided as JsonArray

Request

public Request(Number id,
               String method,
               com.google.gson.JsonObject params)

Creates a Request with parameters in object format.

If id is null the request id will be serialized as the JSON null value. If you want to omit the id you should create a Notification.

If params is null a NullPointerException will be thrown. If you want to create a request without parameters, you should use Request(Number, String)

Parameters:

id - A id of type Number or null

method - The non-null method you want to invoke

params - The parameters provided as JsonObject

Method Detail

jsonrpc

public String jsonrpc()

Getter for jsonrpc field.

It is always "2.0".

Returns:

The version of the JSON-RPC protocol

id

public Optional<Id<?>> id()

Getter for id field.

If the Optional is empty the Request is considered to be a Notification.

Returns:

The id of this Request

method

public String method()

Getter for method field.

Returns:

The name of the method to be invoked

params

public Optional<Parameters<?>> params()

Getter for params field.

Returns:

The parameters of this Request

hashCode

public int hashCode()

This method is implemented using Objects.hash().

Overrides:

hashCode in class Object

Returns:

The hash code for this Request

equals

public boolean equals(Object obj)

This method returns true if the argument is a Request and all properties are equal, otherwise returns false.

Overrides:

equals in class Object

Parameters:

obj - The object to be checked

Returns:

Whether this is the same as the Object argument

toString

public String toString()

The returned String is equal to the value of: "Request@" + Integer.toHexString(hashCode()) + " " + contentAsJsonString() where contentAsJsonString() returns a JSON-like String of this Request.

Overrides:

toString in class Object

Returns:

A String representation of this Request

contentAsJsonString

protected String contentAsJsonString()

The returned String represents the contents of this Request.

Returns:

A JSON-like String of this Request