de.jstacs.tools.ui.cli

Class CLI.SysProtocol

java.lang.Object

de.jstacs.tools.ui.cli.CLI.SysProtocol

All Implemented Interfaces:

Protocol, Flushable

Enclosing class:

CLI

public static class CLI.SysProtocol
extends Object
implements Protocol

Class for a Protocol that prints messages to System.out and warnings to System.err and additionally hold a log of all messages in a local StringBuffer that may be, e.g., stored to a file later.

Author:

Jan Grau

Constructor Summary

Constructors

Constructor and Description
CLI.SysProtocol() Creates a new, empty protocol.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(String str) Appends a general message to the protocol
void	appendHeading(String heading) Appends a heading to the protocol, which is generally highlighted in some appropriate way.
void	appendThrowable(Throwable th) Appends a Throwable to the protocol.
void	appendVerbatim(String verbatim) Appends some verbatim text (i.e., text that is displayed "as is" regardless of default formatting) to the protocol.
void	appendWarning(String warning) Appends a warning to the protocol, which is generally highlighted in some appropriate way.
void	flush()
StringBuffer	getLog() Returns the StringBuffer containing all messages since the creation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLI.SysProtocol

public CLI.SysProtocol()

Creates a new, empty protocol.

Method Detail

append

public void append(String str)

Description copied from interface: Protocol

Appends a general message to the protocol

Specified by:

append in interface Protocol

Parameters:

str - the message

appendHeading

public void appendHeading(String heading)

Description copied from interface: Protocol

Appends a heading to the protocol, which is generally highlighted in some appropriate way.

Specified by:

appendHeading in interface Protocol

Parameters:

heading - the heading

appendWarning

public void appendWarning(String warning)

Description copied from interface: Protocol

Appends a warning to the protocol, which is generally highlighted in some appropriate way.

Specified by:

appendWarning in interface Protocol

Parameters:

warning - the warning

getLog

public StringBuffer getLog()

Returns the StringBuffer containing all messages since the creation of this object.

Returns:

the messages

appendThrowable

public void appendThrowable(Throwable th)

Description copied from interface: Protocol

Appends a Throwable to the protocol. The message of the protocol is generally highlighted in some appropriate way. Depending on the implementation, the stack trace of the Throwable may also be displayed.

Specified by:

appendThrowable in interface Protocol

Parameters:

th - the Throwable

See Also:

Throwable.printStackTrace()

appendVerbatim

public void appendVerbatim(String verbatim)

Description copied from interface: Protocol

Appends some verbatim text (i.e., text that is displayed "as is" regardless of default formatting) to the protocol.

Specified by:

appendVerbatim in interface Protocol

Parameters:

verbatim - the verbatim text

flush

public void flush()

Specified by:

flush in interface Flushable