public interface Protocol extends Flushable
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
.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 append(String str)
str
- the messagevoid appendHeading(String heading)
heading
- the headingvoid appendWarning(String warning)
warning
- the warningvoid appendThrowable(Throwable th)
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.th
- the Throwable
Throwable.printStackTrace()
void appendVerbatim(String verbatim)
verbatim
- the verbatim text