net.morimekta.providence.serializer

Class PFastBinarySerializer

java.lang.Object

net.morimekta.providence.serializer.PSerializer

net.morimekta.providence.serializer.PFastBinarySerializer

public class PFastBinarySerializer
extends PSerializer

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BINARY
protected static int	COLLECTION
protected static int	FIXED_64
protected static int	MESSAGE
protected static int	NONE
protected boolean	readStrict
protected static int	TRUE
protected static int	VARINT

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

DEFAULT_ENTRY_SEP, DEFAULT_STREAM_INITIATOR, DEFAULT_STREAM_TERMINATOR

Constructor Summary

Constructors

Constructor and Description
PFastBinarySerializer() Construct a serializer instance.
PFastBinarySerializer(boolean readStrict) Construct a serializer instance.

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(InputStream is, 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 os, PDescriptor<T> descriptor, T value)
int	serialize(OutputStream os, PMessage<?> message)
protected int	writeMessage(net.morimekta.util.io.BinaryWriter out, 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

Field Detail

readStrict

protected final boolean readStrict

NONE

protected static final int NONE

See Also:

Constant Field Values

TRUE

protected static final int TRUE

See Also:

Constant Field Values

VARINT

protected static final int VARINT

See Also:

Constant Field Values

FIXED_64

protected static final int FIXED_64

See Also:

Constant Field Values

BINARY

protected static final int BINARY

See Also:

Constant Field Values

MESSAGE

protected static final int MESSAGE

See Also:

Constant Field Values

COLLECTION

protected static final int COLLECTION

See Also:

Constant Field Values

Constructor Detail

PFastBinarySerializer

public PFastBinarySerializer()

Construct a serializer instance.

PFastBinarySerializer

public PFastBinarySerializer(boolean readStrict)

Construct a serializer instance.

Method Detail

serialize

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

Specified by:

serialize in class PSerializer

Throws:

IOException

PSerializeException

serialize

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

Specified by:

serialize in class PSerializer

Throws:

IOException

PSerializeException

deserialize

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

Specified by:

deserialize in class PSerializer

Throws:

PSerializeException

IOException

writeMessage

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

Parameters:

out - Writer to write to.

message - Message to write.

Returns:

Number of bytes written.

Throws:

PSerializeException - When serialization failed.

IOException - When unable to write to stream as expected.

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 encoded type.

descriptor - The type descriptor 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