Package eu.bandm.tools.message

Class MessagePrinter<M extends Message>

java.lang.Object

eu.bandm.tools.message.MessagePrinter<M>

Type Parameters:

M - the type of the messages

All Implemented Interfaces:

MessageReceiver<M>

Direct Known Subclasses:

MessagePrinter.Indenting

public class MessagePrinter<M extends Message>
extends Object
implements MessageReceiver<M>

Prints textual representations of all received messages to an output stream.
After each printed message, that stream is flushed explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessagePrinter.Indenting<M extends Message>	Specialization of MessagePrinter with addtional features.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PrintWriter	out	The drain of the print activities.
protected Function<? super M,? extends String>	toStr	The function which converts the message to a printable string.

Constructor Summary

Constructors

Constructor	Description
MessagePrinter()	Prints to System.err, using default encoding.
MessagePrinter(OutputStream os)	Creates and uses as its drain a fresh PrintWriter to the OutputStream argument.
MessagePrinter(PrintWriter out)	Prints to the PrintWriter provided.

Method Summary

Modifier and Type	Method	Description
void	receive(M message)	Print the message to the output stream.
MessagePrinter<M>	setMessageToString(Function<? super M,? extends String> toStr)	Sets the function which converts the message to a printable string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.bandm.tools.message.MessageReceiver

ifSubcriticalThen, ifSubcriticalThen, ifSubcriticalThenElse

Field Details

out

protected final PrintWriter out

The drain of the print activities.

toStr

protected Function<? super M extends Message,? extends String> toStr

The function which converts the message to a printable string. Defaults to Object::toString.

Constructor Details

MessagePrinter

public MessagePrinter()

Prints to System.err, using default encoding.

MessagePrinter

public MessagePrinter(OutputStream os)

Creates and uses as its drain a fresh PrintWriter to the OutputStream argument.
Therefore printing must use the default character encoding.

Parameters:

os - the target of all text output

MessagePrinter

public MessagePrinter(PrintWriter out)

Prints to the PrintWriter provided.

By this, the character encoding can be set explicitly.

Parameters:

out - the target of all text output

Method Details

setMessageToString

public MessagePrinter<M> setMessageToString(Function<? super M,? extends String> toStr)

Sets the function which converts the message to a printable string.

Parameters:

toStr - the function which converts the message to a printable string.

Returns:

this instance, for method chaining.

receive

public void receive(M message)

Print the message to the output stream.

Rendering is done by applying the function in toStr.
After each printed message the output stream is flushed explicitly.

Specified by:

receive in interface MessageReceiver<M extends Message>

Parameters:

message - the message to receive.