net.morimekta.providence.serializer

Class PrettySerializer

java.lang.Object

net.morimekta.providence.serializer.Serializer

net.morimekta.providence.serializer.PrettySerializer

public class PrettySerializer
extends Serializer

Pretty printer that can print message content for easily reading and debugging. This is a write only format used in stringifying messages.

Since:

25.08.15

Author:

Stein Eldar Johnsen

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEDIA_TYPE

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

DEFAULT_STRICT

Constructor Summary

Constructors

Constructor and Description
PrettySerializer()
PrettySerializer(boolean strict)

Method Summary

Modifier and Type	Method and Description
boolean	binaryProtocol()
PrettySerializer	compact() Make a PrettySerializer that generates content similar to the PMessage asString methods.
PrettySerializer	config() Make a PrettySerializer that generates content similar to what the ProvidenceConfig reads.
PrettySerializer	debug() Make a PrettySerializer that generates content with minimal diff.
<Message extends PMessage<Message,Field>,Field extends PField> Message	deserialize(InputStream input, PMessageDescriptor<Message,Field> descriptor) Deserialize a message.
<Message extends PMessage<Message,Field>,Field extends PField> PServiceCall<Message,Field>	deserialize(InputStream input, PService service) Deserialize a service call.
String	mediaType()
<Message extends PMessage<Message,Field>,Field extends PField> int	serialize(OutputStream out, Message message) Serialize a message.
<Message extends PMessage<Message,Field>,Field extends PField> int	serialize(OutputStream out, PServiceCall<Message,Field> call) Serialize a service call.
PrettySerializer	string() Make a PrettySerializer that generates content similar to the PMessage toString methods.

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

Constructor Detail

PrettySerializer

public PrettySerializer()

PrettySerializer

public PrettySerializer(boolean strict)

Method Detail

compact

public PrettySerializer compact()

Make a PrettySerializer that generates content similar to the PMessage asString methods. The output of this has very little whitespace, so can be pretty difficult to read. It's similar to the string() variant, but without the qualified name prefix.

Returns:

Compact pretty serializer.

string

public PrettySerializer string()

Make a PrettySerializer that generates content similar to the PMessage toString methods. The output of this has very little whitespace, so can be pretty difficult to read. It prefixes the message with the root message qualified name, as any PMessage.toString() would expect.

Returns:

String pretty serializer.

config

public PrettySerializer config()

Make a PrettySerializer that generates content similar to what the ProvidenceConfig reads. It will not make use of references or anything fancy though.

Returns:

Config-like pretty serializer.

debug

public PrettySerializer debug()

Make a PrettySerializer that generates content with minimal diff.

Returns:

Debug pretty serializer.

serialize

public <Message extends PMessage<Message,Field>,Field extends PField> int serialize(@Nonnull
                                                                                    OutputStream out,
                                                                                    @Nonnull
                                                                                    Message message)

Description copied from class: Serializer

Serialize a message.

Specified by:

serialize in class Serializer

Type Parameters:

Message - The message type.

Field - The message field type.

Parameters:

out - The output stream to write to.

message - The message to write.

Returns:

The number of bytes written to the output stream.

serialize

public <Message extends PMessage<Message,Field>,Field extends PField> int serialize(@Nonnull
                                                                                    OutputStream out,
                                                                                    @Nonnull
                                                                                    PServiceCall<Message,Field> call)
                                                                             throws IOException

Description copied from class: Serializer

Serialize a service call.

Specified by:

serialize in class Serializer

Type Parameters:

Message - The message type contained in the service call.

Field - The message field type.

Parameters:

out - 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 <Message extends PMessage<Message,Field>,Field extends PField> PServiceCall<Message,Field> 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:

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

Field - 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.

deserialize

@Nonnull
public <Message extends PMessage<Message,Field>,Field extends PField> Message deserialize(@Nonnull
                                                                                                   InputStream input,
                                                                                                   @Nonnull
                                                                                                   PMessageDescriptor<Message,Field> descriptor)
                                                                                            throws IOException

Description copied from class: Serializer

Deserialize a message.

Specified by:

deserialize in class Serializer

Type Parameters:

Message - The message type.

Field - The message field type.

Parameters:

input - The input stream to read from.

descriptor - The descriptor of the message to read.

Returns:

The message 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.