de.jstacs.tools

Interface Protocol

All Superinterfaces:

Flushable

All Known Implementing Classes:

CLI.SysProtocol, GalaxyAdaptor.Protocol

public interface Protocol
extends Flushable

Interface for the protocol of the run of a JstacsTool. Within a JstacsTool, only this generic interface should be used. The implementation of the methods highly depends on the interface, e.g., CLI or Galaxy.

Author:

Jan Grau

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.

Methods inherited from interface java.io.Flushable

flush

Method Detail

append

void append(String str)

Appends a general message to the protocol

Parameters:

str - the message

appendHeading

void appendHeading(String heading)

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

Parameters:

heading - the heading

appendWarning

void appendWarning(String warning)

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

Parameters:

warning - the warning

appendThrowable

void appendThrowable(Throwable th)

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.

Parameters:

th - the Throwable

See Also:

Throwable.printStackTrace()

appendVerbatim

void appendVerbatim(String verbatim)

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

Parameters:

verbatim - the verbatim text