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). - Message validity will be ignored. If strict more is ON: - Unknown enum values will fail deserialization. - Message invalidity will fail 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}
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_MEDIA_TYPE
static String	MEDIA_TYPE

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

DEFAULT_STRICT

Constructor Summary

Constructors

Constructor and Description
JsonSerializer()
JsonSerializer(boolean strict)

Method Summary

Modifier and Type	Method and Description
boolean	binaryProtocol()
<T extends PMessage<T,TF>,TF extends PField> T	deserialize(InputStream input, PMessageDescriptor<T,TF> type) Deserialize a message.
<T extends PMessage<T,F>,F extends PField> PServiceCall<T,F>	deserialize(InputStream input, PService service) Deserialize a service call.
String	mediaType()
JsonSerializer	named()
JsonSerializer	pretty()
<T extends PMessage<T,F>,F extends PField> int	serialize(OutputStream output, PServiceCall<T,F> call) Serialize a service call.
<T extends PMessage<T,F>,F extends PField> int	serialize(OutputStream output, T message) Serialize a message.
JsonSerializer	withNamedEnums()
JsonSerializer	withNamedFields()

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

isRequestCallType

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_TYPE

public static final String MEDIA_TYPE

See Also:

Constant Field Values

JSON_MEDIA_TYPE

public static final String JSON_MEDIA_TYPE

See Also:

Constant Field Values

Constructor Detail

JsonSerializer

public JsonSerializer()

JsonSerializer

public JsonSerializer(boolean strict)

Method Detail

pretty

public JsonSerializer pretty()

named

public JsonSerializer named()

withNamedFields

public JsonSerializer withNamedFields()

withNamedEnums

public JsonSerializer withNamedEnums()

serialize

public <T extends PMessage<T,F>,F extends PField> int serialize(@Nonnull
                                                                OutputStream output,
                                                                @Nonnull
                                                                T message)
                                                         throws IOException

Description copied from class: Serializer

Serialize a message.

Specified by:

serialize in class Serializer

Type Parameters:

T - The message type.

F - The message field type.

Parameters:

output - The output stream to write to.

message - The message to write.

Returns:

The number of bytes written to the output stream.

Throws:

IOException - If writing or serialization failed.

serialize

public <T extends PMessage<T,F>,F extends PField> int serialize(@Nonnull
                                                                OutputStream output,
                                                                @Nonnull
                                                                PServiceCall<T,F> call)
                                                         throws IOException

Description copied from class: Serializer

Serialize a service call.

Specified by:

serialize in class Serializer

Type Parameters:

T - The message type contained in the service call.

F - The message field type.

Parameters:

output - The output stream to write to.

call - The service call to write.

Returns:

The number of bytes written to the output stream.

Throws:

IOException - If writing or serialization failed.

deserialize

@Nonnull
public <T extends PMessage<T,TF>,TF extends PField> T deserialize(@Nonnull
                                                                           InputStream input,
                                                                           @Nonnull
                                                                           PMessageDescriptor<T,TF> type)
                                                                    throws IOException

Description copied from class: Serializer

Deserialize a message.

Specified by:

deserialize in class Serializer

Type Parameters:

T - The message type.

TF - The message field type.

Parameters:

input - The input stream to read from.

type - The descriptor of the message to read.

Returns:

The message read.

Throws:

IOException - If reading or deserialization failed.

deserialize

@Nonnull
public <T extends PMessage<T,F>,F extends PField> PServiceCall<T,F> deserialize(@Nonnull
                                                                                         InputStream input,
                                                                                         @Nonnull
                                                                                         PService service)
                                                                                  throws IOException

Description copied from class: Serializer

Deserialize a service call.

Specified by:

deserialize in class Serializer

Type Parameters:

T - The message type contained in the returned service call.

F - The message field type.

Parameters:

input - The input stream to read from.

service - The service definition to read for.

Returns:

The service call read.

Throws:

IOException - If reading or deserialization failed.

binaryProtocol

public boolean binaryProtocol()

Specified by:

binaryProtocol in class Serializer

Returns:

True if the protocol of the serializer is "binary" a.k.a. unreadable to most humans.

mediaType

@Nonnull
public String mediaType()

Specified by:

mediaType in class Serializer

Returns:

Media type of the content generated by the serializer. Can be used for Content-Type and Accept HTTP headers, MIME type etc.