net.morimekta.providence.serializer

Class JsonSerializer

java.lang.Object

net.morimekta.providence.serializer.Serializer

net.morimekta.providence.serializer.JsonSerializer

public class JsonSerializer
extends Serializer

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}
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonSerializer.IdType

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_MIME_TYPE
static String	MIME_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	binaryProtocol()
<T extends PMessage<T>> PServiceCall<T>	deserialize(InputStream input, PService service)
<T extends PMessage<T>,TF extends PField> T	deserialize(InputStream input, PStructDescriptor<T,TF> type)
String	mimeType()
<T extends PMessage<T>> int	serialize(OutputStream output, PServiceCall<T> call)
<T extends PMessage<T>> int	serialize(OutputStream output, T message)

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

cast

Methods inherited from class java.lang.Object

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

Field Detail

MIME_TYPE

public static final String MIME_TYPE

See Also:

Constant Field Values

JSON_MIME_TYPE

public static final String JSON_MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

JsonSerializer

public JsonSerializer()

JsonSerializer

public JsonSerializer(boolean strict)

JsonSerializer

public JsonSerializer(JsonSerializer.IdType idType)

JsonSerializer

public JsonSerializer(boolean readStrict,
                      JsonSerializer.IdType idType)

JsonSerializer

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

JsonSerializer

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

Method Detail

serialize

public <T extends PMessage<T>> int serialize(OutputStream output,
                                             T message)
                                      throws SerializerException

Specified by:

serialize in class Serializer

Throws:

SerializerException

serialize

public <T extends PMessage<T>> int serialize(OutputStream output,
                                             PServiceCall<T> call)
                                      throws IOException,
                                             SerializerException

Specified by:

serialize in class Serializer

Throws:

IOException

SerializerException

deserialize

public <T extends PMessage<T>,TF extends PField> T deserialize(InputStream input,
                                                               PStructDescriptor<T,TF> type)
                                                        throws SerializerException

Specified by:

deserialize in class Serializer

Throws:

SerializerException

deserialize

public <T extends PMessage<T>> PServiceCall<T> deserialize(InputStream input,
                                                           PService service)
                                                    throws SerializerException

Specified by:

deserialize in class Serializer

Throws:

SerializerException

binaryProtocol

public boolean binaryProtocol()

Specified by:

binaryProtocol in class Serializer

mimeType

public String mimeType()

Specified by:

mimeType in class Serializer