edu.wpi.rail.jrosbridge

Class JsonWrapper

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

Direct Known Subclasses:

Message, Primitive, ServiceRequest, ServiceResponse

public abstract class JsonWrapper
extends Object

JsonWrapper objects are used as a wrapper around JSON objects. That is, they are a reusable convince for messages and services. This objects are immutable and declared abstract as they should not be used directly.

Version:

April 1, 2014

Author:

Russell Toris - rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_JSON The String representation of an empty message in JSON.

Constructor Summary

Constructors

Constructor and Description
JsonWrapper() Create a new, empty JSON object.
JsonWrapper(javax.json.JsonObject jsonObject) Create a Message based on the given JSON object.
JsonWrapper(String jsonString) Create a JSON object based on the given String representation of a JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
abstract JsonWrapper	clone() Create a clone of this JSON object.
boolean	equals(Object o) Test if the given Object is equal to this JsonWrapper.
int	hashCode() Return the hash code of this JSON object, which is the hash code of the JSON string.
javax.json.JsonObject	toJsonObject() Get the JSON object.
String	toString() Get the String representation of this JSON object in JSON format.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_JSON

public static final String EMPTY_JSON

The String representation of an empty message in JSON.

See Also:

Constant Field Values

Constructor Detail

JsonWrapper

public JsonWrapper()

Create a new, empty JSON object.

JsonWrapper

public JsonWrapper(String jsonString)

Create a JSON object based on the given String representation of a JSON object.

Parameters:

json - The JSON String to parse.

JsonWrapper

public JsonWrapper(javax.json.JsonObject jsonObject)

Create a Message based on the given JSON object.

Parameters:

jsonObject - The JSON object containing the message data.

Method Detail

toJsonObject

public javax.json.JsonObject toJsonObject()

Get the JSON object.

Returns:

The JSON object.

toString

public String toString()

Get the String representation of this JSON object in JSON format.

Overrides:

toString in class Object

Returns:

The String representation of this JSON object in JSON format.

clone

public abstract JsonWrapper clone()

Create a clone of this JSON object.

Overrides:

clone in class Object

hashCode

public int hashCode()

Return the hash code of this JSON object, which is the hash code of the JSON string.

Overrides:

hashCode in class Object

Returns:

The hash code of the message.

equals

public boolean equals(Object o)

Test if the given Object is equal to this JsonWrapper. Two JsonWrappers are equal if and only if their JSON strings match.

Overrides:

equals in class Object

Parameters:

o - The Object to test equality with.

Returns:

If the given Object is equal to this JsonWrapper.