net.morimekta.providence.logging

Class LogFormatter

java.lang.Object

net.morimekta.providence.logging.LogFormatter

public class LogFormatter
extends Object

LogFormatter is a formatter (one-way serialization) similar to the PrettySerializer, except it supports adding FieldHandlers to modify in. Note that the LogFormatter is not a serializer, as there is no guarantee the result can be parsed back at all.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogFormatter.FieldHandler Handler for a single field in a message.

Constructor Summary

Constructors

Constructor and Description
LogFormatter(boolean pretty, Collection<LogFormatter.FieldHandler> fieldHandlers) Create a log formatter.
LogFormatter(boolean pretty, LogFormatter.FieldHandler... fieldHandlers) Create a log formatter.
LogFormatter(LogFormatter.FieldHandler... fieldHandlers) Create a log formatter with compact format.

Method Summary

Modifier and Type	Method and Description
<Message extends net.morimekta.providence.PMessage<Message>> String	format(net.morimekta.providence.PMessageOrBuilder<Message> message) Format message to a string.
<Message extends net.morimekta.providence.PMessage<Message>> void	formatTo(OutputStream out, net.morimekta.providence.PMessageOrBuilder<Message> message) Format message and write to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogFormatter

public LogFormatter(LogFormatter.FieldHandler... fieldHandlers)

Create a log formatter with compact format.

Parameters:

fieldHandlers - Field handlers to specify formatted values of specific fields.

LogFormatter

public LogFormatter(boolean pretty,
                    LogFormatter.FieldHandler... fieldHandlers)

Create a log formatter.

Parameters:

pretty - If true will add lines, line indentation and extra spaces.

fieldHandlers - Field handlers to specify formatted values of specific fields.

LogFormatter

public LogFormatter(boolean pretty,
                    Collection<LogFormatter.FieldHandler> fieldHandlers)

Create a log formatter.

Parameters:

pretty - If true will add lines, line indentation and extra spaces.

fieldHandlers - Field handlers to specify formatted values of specific fields.

Method Detail

formatTo

public <Message extends net.morimekta.providence.PMessage<Message>> void formatTo(OutputStream out,
                                                                                  net.morimekta.providence.PMessageOrBuilder<Message> message)

Format message and write to the output stream.

Type Parameters:

Message - The message type.

Parameters:

out - The output stream to write to.

message - The message to be written.

format

public <Message extends net.morimekta.providence.PMessage<Message>> String format(net.morimekta.providence.PMessageOrBuilder<Message> message)

Format message to a string.

Type Parameters:

Message - The message type.

Parameters:

message - The message to be written.

Returns:

The formatted message.