com.openxc.messages.formatters

Class BinaryFormatter

java.lang.Object

com.openxc.messages.formatters.BinaryFormatter

public class BinaryFormatter
extends java.lang.Object

A formatter for serializing and deserializing Protocol Buffers, i.e. the OpenXC binary message format.

Constructor Summary

Constructors

Constructor and Description
BinaryFormatter()

Method Summary

Modifier and Type	Method and Description
static VehicleMessage	deserialize(java.io.InputStream data) Deserialize a single vehicle message from the input stream.
static MessageLite	preSerialize(VehicleMessage message) Serialize a VehicleMessage into an intermediate protobuf object.
static byte[]	serialize(VehicleMessage message) Serialize a VehicleMessage into a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryFormatter

public BinaryFormatter()

Method Detail

deserialize

public static VehicleMessage deserialize(java.io.InputStream data)
                                  throws UnrecognizedMessageTypeException

Deserialize a single vehicle message from the input stream.

Parameters:

data - The stream that should include protobuf-encoded vehicle messages.

Returns:

the deserialized VehicleMessage

Throws:

UnrecognizedMessageTypeException - if a message could not be deserialized.

serialize

public static byte[] serialize(VehicleMessage message)
                        throws SerializationException

Serialize a VehicleMessage into a byte array.

Parameters:

message - the VehicleMessage to serialize.

Returns:

the message serialized to bytes.

Throws:

SerializationException - if there was an error with serializing the message.

preSerialize

public static MessageLite preSerialize(VehicleMessage message)
                                throws SerializationException

Serialize a VehicleMessage into an intermediate protobuf object. This used to write delimited, serialized messages to a stream for the binary format

Throws:

SerializationException