net.morimekta.providence.serializer

Class PProtoSerializer

java.lang.Object

net.morimekta.providence.serializer.PSerializer

net.morimekta.providence.serializer.PProtoSerializer

public class PProtoSerializer
extends PSerializer

Compact binary serializer using the protocol buffer serialization format.

The format is very simple, though has some drawbacks:

• Contained Messages are serialized and written as bytes, requiring the message writer to serialize the message internally, then write that to the output stream.

  TODO: Possible improvement is to use recycled byte buffers instead of fresh ByteArrayOutputStream each time.

• Lists and sets are handled as repeated fields.
• Contained lists and sets are handled as compacted repeated fields.
• Maps are faked as separate messages, making a virtual message containing the inner fields:
  • required KeyType key = 1;
  • required ValueType value = 2;
• All numbers are assumed to be varints, except double which is fixed64.

See data definition file docs/proto-serializer.md for format spec and type matching.

Field Summary

Fields inherited from class net.morimekta.providence.serializer.PSerializer

DEFAULT_ENTRY_SEP, DEFAULT_STREAM_INITIATOR, DEFAULT_STREAM_TERMINATOR

Constructor Summary

Constructors

Constructor and Description
PProtoSerializer() Construct a serializer instance.
PProtoSerializer(boolean strict) Construct a serializer instance.

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(InputStream input, PDescriptor<T> descriptor)
protected <T> T	readFieldValue(net.morimekta.util.io.BinaryReader in, int type, PDescriptor<T> descriptor) Read a field value from stream.
<T> int	serialize(OutputStream output, PDescriptor<T> descriptor, T value)
int	serialize(OutputStream output, PMessage<?> message)
protected int	writeFieldValue(net.morimekta.util.io.BinaryWriter out, int tag, PDescriptor<?> descriptor, Object value) Write a field value to stream.
protected int	writeMessage(net.morimekta.util.io.BinaryWriter writer, PMessage<?> message)

Methods inherited from class net.morimekta.providence.serializer.PSerializer

cast, entrySeparator, streamInitiator, streamInitiatorPartOfData, streamTerminator

Methods inherited from class java.lang.Object

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

Constructor Detail

PProtoSerializer

public PProtoSerializer()

Construct a serializer instance.

PProtoSerializer

public PProtoSerializer(boolean strict)

Construct a serializer instance.

Method Detail

serialize

public int serialize(OutputStream output,
                     PMessage<?> message)
              throws IOException,
                     PSerializeException

Specified by:

serialize in class PSerializer

Throws:

IOException

PSerializeException

serialize

public <T> int serialize(OutputStream output,
                         PDescriptor<T> descriptor,
                         T value)
                  throws IOException,
                         PSerializeException

Specified by:

serialize in class PSerializer

Throws:

IOException

PSerializeException

deserialize

public <T> T deserialize(InputStream input,
                         PDescriptor<T> descriptor)
                  throws PSerializeException,
                         IOException

Specified by:

deserialize in class PSerializer

Throws:

PSerializeException

IOException

writeMessage

protected int writeMessage(net.morimekta.util.io.BinaryWriter writer,
                           PMessage<?> message)
                    throws IOException,
                           PSerializeException

Throws:

IOException

PSerializeException

readFieldValue

protected <T> T readFieldValue(net.morimekta.util.io.BinaryReader in,
                               int type,
                               PDescriptor<T> descriptor)
                        throws IOException,
                               PSerializeException

Read a field value from stream.

Parameters:

in - The stream to consume.

type - The field info about the content.

descriptor - The type to generate content for.

Returns:

The field value, or null if no type.

Throws:

IOException - If unable to read from stream or invalid field type.

PSerializeException

writeFieldValue

protected int writeFieldValue(net.morimekta.util.io.BinaryWriter out,
                              int tag,
                              PDescriptor<?> descriptor,
                              Object value)
                       throws IOException,
                              PSerializeException

Write a field value to stream.

Parameters:

out - The stream to write to.

value - The value to write.

Returns:

The number of bytes written.

Throws:

IOException

PSerializeException