de.jstacs.tools.ui.galaxy

Class GalaxyAdaptor.Protocol

java.lang.Object

de.jstacs.tools.ui.galaxy.GalaxyAdaptor.Protocol

All Implemented Interfaces:

Protocol, Flushable

Enclosing class:

GalaxyAdaptor

public static class GalaxyAdaptor.Protocol
extends Object
implements Protocol

Class for a Protocol writer.

Author:

Jan Grau

Constructor Summary

Constructors

Constructor and Description
Protocol() Creates a new Protocol

Method Summary

Modifier and Type	Method and Description
void	append(String str) Appends str to the protocol.
void	appendHeading(String str) Append a heading to the protocol
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 str) Appends a warning to the protocol
void	flush()
ByteArrayOutputStream	getOutputStream() Returns the ByteArrayOutputStream of this protocol
PrintWriter	getWriter() Returns the PrintWriter of this protocol
String	toString() Returns the current version of the protocol as String.

Methods inherited from class java.lang.Object

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

Constructor Detail

Protocol

public Protocol()

Creates a new Protocol

Method Detail

append

public void append(String str)

Appends str to the protocol.

Specified by:

append in interface Protocol

Parameters:

str - the string to be appended

getWriter

public PrintWriter getWriter()

Returns the PrintWriter of this protocol

Returns:

the writer

getOutputStream

public ByteArrayOutputStream getOutputStream()

Returns the ByteArrayOutputStream of this protocol

Returns:

the stream

appendHeading

public void appendHeading(String str)

Append a heading to the protocol

Specified by:

appendHeading in interface Protocol

Parameters:

str - the title of the heading

appendWarning

public void appendWarning(String str)

Appends a warning to the protocol

Specified by:

appendWarning in interface Protocol

Parameters:

str - the warning

toString

public String toString()

Returns the current version of the protocol as String.

Overrides:

toString in class Object

Returns:

the protocol as String

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()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException