net.morimekta.providence.serializer

Class PJsonSerializer

java.lang.Object

net.morimekta.providence.serializer.PSerializer

net.morimekta.providence.serializer.PJsonSerializer

public class PJsonSerializer
extends PSerializer

Compact JSON serializer. This uses the most compact type-safe JSON format allowable. There are two optional variants switching the struct field ID between numeric ID and field name.

There is also the strict mode. If strict is OFF: - Unknown enum values will be ignored (as field missing). - Unknown fields will be ignored. - Struct validity will be ignored. If strict more is ON: - Unknown enum values will fail the deserialization. - Unknown fields will fail the deserialization. - Struct validity will fail both serialization and deserialization.

Format is like this:

 {
     "id":value,
     "structId":{ ... },
     "listId":[value1,value2],
     "mapId":{"id1":value1,"id2":value2}
 }
 

But without formatting spaces. The formatted JSON can be read normally. Binary fields are base64 encoded.

This format supports 'compact' struct formatting. A compact struct is formatted as a list with fields in order from 1 to N. E.g.:

 ["tag",5,6.45]
 

is equivalent to:

 {"1":"tag","2":5,"3":6.45}
 

Since:

25.08.15

Author:

Stein Eldar Johnsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PJsonSerializer.IdType

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	ENTRY_SEP
static byte[]	STREAM_INITIATOR

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

DEFAULT_ENTRY_SEP, DEFAULT_STREAM_INITIATOR, DEFAULT_STREAM_TERMINATOR

Constructor Summary

Constructors

Constructor and Description
PJsonSerializer()
PJsonSerializer(boolean strict)
PJsonSerializer(boolean readStrict, PJsonSerializer.IdType idType)
PJsonSerializer(boolean readStrict, PJsonSerializer.IdType idType, PJsonSerializer.IdType enumType, boolean pretty)
PJsonSerializer(PJsonSerializer.IdType idType)
PJsonSerializer(PJsonSerializer.IdType idType, PJsonSerializer.IdType enumType)

Method Summary

Modifier and Type	Method and Description
protected void	appendMessage(net.morimekta.util.json.JsonWriter writer, PMessage<?> message)
protected void	appendPrimitive(net.morimekta.util.json.JsonWriter writer, Object primitive) Append a primitive value to json struct.
protected void	appendPrimitiveKey(net.morimekta.util.json.JsonWriter writer, Object primitive)
protected void	appendTypedValue(net.morimekta.util.json.JsonWriter writer, PDescriptor type, Object value)
<T> T	deserialize(InputStream input, PDescriptor<T> type)
protected <T extends PMessage<T>> T	parseCompactMessage(net.morimekta.util.json.JsonTokenizer tokenizer, PStructDescriptor<T,?> type) Parse JSON object as a message.
protected Object	parseMapKey(String key, PDescriptor keyType)
protected <T extends PMessage<T>> T	parseMessage(net.morimekta.util.json.JsonTokenizer tokenizer, PStructDescriptor<T,?> type) Parse JSON object as a message.
protected <T> T	parseTypedValue(net.morimekta.util.json.JsonToken token, net.morimekta.util.json.JsonTokenizer tokenizer, PDescriptor<T> t)
<T> int	serialize(OutputStream output, PDescriptor<T> descriptor, T value)
int	serialize(OutputStream output, PMessage<?> message)
byte[]	streamInitiator()

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

cast, entrySeparator, streamInitiatorPartOfData, streamTerminator

Methods inherited from class java.lang.Object

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

Field Detail

STREAM_INITIATOR

public static final byte[] STREAM_INITIATOR

ENTRY_SEP

public static final byte[] ENTRY_SEP

Constructor Detail

PJsonSerializer

public PJsonSerializer()

PJsonSerializer

public PJsonSerializer(boolean strict)

PJsonSerializer

public PJsonSerializer(PJsonSerializer.IdType idType)

PJsonSerializer

public PJsonSerializer(boolean readStrict,
                       PJsonSerializer.IdType idType)

PJsonSerializer

public PJsonSerializer(PJsonSerializer.IdType idType,
                       PJsonSerializer.IdType enumType)

PJsonSerializer

public PJsonSerializer(boolean readStrict,
                       PJsonSerializer.IdType idType,
                       PJsonSerializer.IdType enumType,
                       boolean pretty)

Method Detail

streamInitiator

public byte[] streamInitiator()

Overrides:

streamInitiator in class PSerializer

serialize

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

Specified by:

serialize in class PSerializer

Throws:

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> type)
                  throws PSerializeException

Specified by:

deserialize in class PSerializer

Throws:

PSerializeException

parseMessage

protected <T extends PMessage<T>> T parseMessage(net.morimekta.util.json.JsonTokenizer tokenizer,
                                                 PStructDescriptor<T,?> type)
                                          throws PSerializeException,
                                                 net.morimekta.util.json.JsonException,
                                                 IOException

Parse JSON object as a message.

Type Parameters:

T - Message generic type.

Parameters:

tokenizer - The object to parse.

type - The message type.

Returns:

The parsed message.

Throws:

PSerializeException

net.morimekta.util.json.JsonException

IOException

parseCompactMessage

protected <T extends PMessage<T>> T parseCompactMessage(net.morimekta.util.json.JsonTokenizer tokenizer,
                                                        PStructDescriptor<T,?> type)
                                                 throws PSerializeException,
                                                        IOException,
                                                        net.morimekta.util.json.JsonException

Parse JSON object as a message.

Type Parameters:

T - Message generic type.

Parameters:

tokenizer - The object to parse.

type - The message type.

Returns:

The parsed message.

Throws:

PSerializeException

IOException

net.morimekta.util.json.JsonException

parseTypedValue

protected <T> T parseTypedValue(net.morimekta.util.json.JsonToken token,
                                net.morimekta.util.json.JsonTokenizer tokenizer,
                                PDescriptor<T> t)
                         throws IOException,
                                PSerializeException

Throws:

IOException

PSerializeException

parseMapKey

protected Object parseMapKey(String key,
                             PDescriptor keyType)
                      throws PSerializeException

Throws:

PSerializeException

appendMessage

protected void appendMessage(net.morimekta.util.json.JsonWriter writer,
                             PMessage<?> message)
                      throws PSerializeException,
                             net.morimekta.util.json.JsonException

Throws:

PSerializeException

net.morimekta.util.json.JsonException

appendTypedValue

protected void appendTypedValue(net.morimekta.util.json.JsonWriter writer,
                                PDescriptor type,
                                Object value)
                         throws PSerializeException,
                                net.morimekta.util.json.JsonException

Throws:

PSerializeException

net.morimekta.util.json.JsonException

appendPrimitiveKey

protected void appendPrimitiveKey(net.morimekta.util.json.JsonWriter writer,
                                  Object primitive)
                           throws net.morimekta.util.json.JsonException,
                                  PSerializeException

Parameters:

writer - The writer to add primitive key to.

primitive - Primitive object to get map key value of.

Throws:

net.morimekta.util.json.JsonException

PSerializeException

appendPrimitive

protected void appendPrimitive(net.morimekta.util.json.JsonWriter writer,
                               Object primitive)
                        throws net.morimekta.util.json.JsonException,
                               PSerializeException

Append a primitive value to json struct.

Parameters:

writer - The JSON writer.

primitive - The primitive instance.

Throws:

net.morimekta.util.json.JsonException

PSerializeException