eu.bandm.tools.message

Class MessagePrinter.Indenting<M extends Message>

java.lang.Object

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

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

All Implemented Interfaces:

MessageReceiver<M>

Enclosing class:

MessagePrinter<M extends Message>

public static class MessagePrinter.Indenting<M extends Message>
extends MessagePrinter<M>

Specialization of MessagePrinter which indents all log messages.
Whenever a Message.Kind.logStart or Message.Kind.logEnd is encountered, indentation is in/de-creased.
Whenever a SimpleMessage.Ping message is received, only a single character symbole is printed, for progress indication.
The string values for indentation and pinging are defined at construction time.
Error, warning and hint messages are not indented, for not disturbing their recognition by a parser, e.g. by XEmac's "next-error" function.

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.message.MessagePrinter

MessagePrinter.Indenting<M extends Message>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	color_endCritical
protected String	color_startCritical
static String	DEFAULT_INDENT_STRING default value for the indent string, is "| ".
static String	DEFAULT_PING_STRING default value for the indent string, is ".".
protected String	indentString
protected int	level
protected String	pingString
protected boolean	printTiming
protected boolean	showStackTraces
protected Map<String,Long>	startTime
protected boolean	wasPing

Fields inherited from class eu.bandm.tools.message.MessagePrinter

out, toStr

Constructor Summary

Constructors

Constructor and Description
Indenting(OutputStream os) constructor with takes default values for indent and ping string, behaves like the super constructor.
Indenting(OutputStream os, String ps, String is, boolean sst) constructor which takes explitly values for ping string and indent string, apart from that it behaves like the super constructor.
Indenting(PrintWriter out) constructor with takes default values for indent and ping string, behaves like the super constructor.
Indenting(PrintWriter out, String ps, String is, boolean sst) constructor which takes explitly values for ping string and indent string, apart from that behaves like the super constructor.

Method Summary

Modifier and Type	Method and Description
void	receive(M message) Print the message to the output stream. Rendering is done by calling Message.toString().
void	setCriticalColor_vt100()
void	setCriticalColor(String color_startCritical, String color_endCritical)
void	setShowStackTraces(boolean sst)

Methods inherited from class eu.bandm.tools.message.MessagePrinter

setMessageToString

Methods inherited from class java.lang.Object

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

Field Detail

pingString

protected final String pingString

indentString

protected final String indentString

showStackTraces

protected boolean showStackTraces

color_startCritical

protected String color_startCritical

color_endCritical

protected String color_endCritical

wasPing

protected boolean wasPing

level

protected int level

printTiming

protected boolean printTiming

startTime

protected Map<String,Long> startTime

DEFAULT_INDENT_STRING

public static final String DEFAULT_INDENT_STRING

default value for the indent string, is "| ".

See Also:

Constant Field Values

DEFAULT_PING_STRING

public static final String DEFAULT_PING_STRING

default value for the indent string, is ".".

See Also:

Constant Field Values

Constructor Detail

Indenting

public Indenting(OutputStream os)

constructor with takes default values for indent and ping string, behaves like the super constructor.

Indenting

public Indenting(PrintWriter out)

constructor with takes default values for indent and ping string, behaves like the super constructor.

Indenting

public Indenting(OutputStream os,
                 String ps,
                 String is,
                 boolean sst)

constructor which takes explitly values for ping string and indent string, apart from that it behaves like the super constructor.

Indenting

public Indenting(PrintWriter out,
                 String ps,
                 String is,
                 boolean sst)

constructor which takes explitly values for ping string and indent string, apart from that behaves like the super constructor.

Method Detail

setShowStackTraces

public void setShowStackTraces(boolean sst)

setCriticalColor

public void setCriticalColor(String color_startCritical,
                             String color_endCritical)

setCriticalColor_vt100

public void setCriticalColor_vt100()

receive

public void receive(M message)

Description copied from class: MessagePrinter

Print the message to the output stream.

Rendering is done by calling Message.toString().
After each printed message the output stream is flushed explicitly.

Specified by:

receive in interface MessageReceiver<M extends Message>

Overrides:

receive in class MessagePrinter<M extends Message>