com.openxc.messages.formatters

Class JsonFormatter

java.lang.Object

com.openxc.messages.formatters.JsonFormatter

public class JsonFormatter
extends java.lang.Object

A formatter for serializing and deserializing JSON OpenXC messages.

Constructor Summary

Constructors

Constructor and Description
JsonFormatter()

Method Summary

Modifier and Type	Method and Description
static VehicleMessage	deserialize(java.lang.String data) Deserialize a single vehicle messages from the string.
static java.lang.String	serialize(java.util.Collection<VehicleMessage> messages) Serialize a collection of messages to a string.
static java.lang.String	serialize(VehicleMessage message) Serialize a vehicle message to a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonFormatter

public JsonFormatter()

Method Detail

serialize

public static java.lang.String serialize(VehicleMessage message)

Serialize a vehicle message to a string.

Parameters:

message - the message to serialize

Returns:

the message serialized to a String.

serialize

public static java.lang.String serialize(java.util.Collection<VehicleMessage> messages)

Serialize a collection of messages to a string. Each message will be serialized to a JSON object, and they will all be included in a JSON array in the result.

Parameters:

messages - the messages to serialize.

Returns:

the messages serialized individually and in a JSON array.

deserialize

public static VehicleMessage deserialize(java.lang.String data)
                                  throws UnrecognizedMessageTypeException

Deserialize a single vehicle messages from the string.

Parameters:

data - a String containing the JSON serialized vehicle message.

Returns:

the deserialized VehicleMessage.

Throws:

UnrecognizedMessageTypeException - if no message could be deserialized.