net.morimekta.providence.serializer

Class PBinarySerializer

java.lang.Object

net.morimekta.providence.serializer.PSerializer

net.morimekta.providence.serializer.PBinarySerializer

public class PBinarySerializer
extends PSerializer

Compact binary serializer. This uses the most compact binary format allowable.

See data definition file docs/compact-binary.md for format spec.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	PBinarySerializer.DataType DataType.
protected static class	PBinarySerializer.FieldInfo Field info data holder with convenience methods.

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
PBinarySerializer() Construct a serializer instance.
PBinarySerializer(boolean strict) Construct a serializer instance.

Method Summary

Modifier and Type	Method and Description
protected void	consumeMessage(net.morimekta.util.io.BinaryReader in) Consume a message from the stream without parsing the content into a message.
<T> T	deserialize(InputStream input, PDescriptor<T> descriptor)
protected int	getArrayLengthBytes(int length)
protected int	getNumericByteLength(long value)
protected int	getNumericByteLengthFlag(long value)
protected PBinarySerializer.FieldInfo	readEntryFieldInfo(net.morimekta.util.io.BinaryReader in, int fieldId)
protected PBinarySerializer.FieldInfo	readFieldInfo(net.morimekta.util.io.BinaryReader in) Read field info from stream.
protected <T> T	readFieldValue(net.morimekta.util.io.BinaryReader in, PBinarySerializer.FieldInfo fieldInfo, PDescriptor<T> type) Read a field value from stream.
<T> int	serialize(OutputStream output, PDescriptor<T> descriptor, T value)
int	serialize(OutputStream output, PMessage<?> message)
protected int	writeBinary(net.morimekta.util.io.BinaryWriter out, net.morimekta.util.Binary bytes)
protected int	writeDouble(net.morimekta.util.io.BinaryWriter out, double value) Write a double value to stream.
protected int	writeFieldValue(net.morimekta.util.io.BinaryWriter out, Object value) Write a field value to stream.

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

PBinarySerializer

public PBinarySerializer()

Construct a serializer instance.

PBinarySerializer

public PBinarySerializer(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

consumeMessage

protected void consumeMessage(net.morimekta.util.io.BinaryReader in)
                       throws IOException,
                              PSerializeException

Consume a message from the stream without parsing the content into a message.

Parameters:

in - Stream to read message from.

Throws:

IOException

PSerializeException

readFieldInfo

protected PBinarySerializer.FieldInfo readFieldInfo(net.morimekta.util.io.BinaryReader in)
                                             throws IOException,
                                                    PSerializeException

Read field info from stream. If this is the last field (field ID 0) return null.

Parameters:

in - The stream to consume.

Returns:

The field info or null.

Throws:

IOException

PSerializeException

readEntryFieldInfo

protected PBinarySerializer.FieldInfo readEntryFieldInfo(net.morimekta.util.io.BinaryReader in,
                                                         int fieldId)
                                                  throws IOException,
                                                         PSerializeException

Throws:

IOException

PSerializeException

readFieldValue

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

Read a field value from stream.

Parameters:

in - The stream to consume.

fieldInfo - The field info about the content.

type - 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,
                              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

writeDouble

protected int writeDouble(net.morimekta.util.io.BinaryWriter out,
                          double value)
                   throws IOException

Write a double value to stream.

Parameters:

out - The stream to write to.

value - The double value to write.

Returns:

The number of bytes written.

Throws:

IOException

writeBinary

protected int writeBinary(net.morimekta.util.io.BinaryWriter out,
                          net.morimekta.util.Binary bytes)
                   throws IOException

Parameters:

out -

bytes -

Returns:

Throws:

IOException

getArrayLengthBytes

protected int getArrayLengthBytes(int length)

Parameters:

length -

Returns:

getNumericByteLength

protected int getNumericByteLength(long value)

Parameters:

value -

Returns:

getNumericByteLengthFlag

protected int getNumericByteLengthFlag(long value)

Parameters:

value -

Returns: