de.lmu.ifi.dbs.elki.utilities.progress
Interface Progress

All Known Implementing Classes:

AbstractProgress, FiniteProgress, IndefiniteProgress

public interface Progress

Generic Progress logging interface.

Author:

Erich Schubert

Method Summary

StringBuffer	appendToBuffer(StringBuffer buf) Serialize a description into a String buffer.
boolean	complete() Test whether a progress is complete (and thus doesn't need to be shown anymore)
String	toString() Returns a String representation of the progress suitable as a message for printing to the command line interface.

Method Detail

appendToBuffer

StringBuffer appendToBuffer(StringBuffer buf)

Serialize a description into a String buffer.

Parameters:

buf - Buffer to serialize to

Returns:

Buffer the data was serialized to.

complete

boolean complete()

Test whether a progress is complete (and thus doesn't need to be shown anymore)

Returns:

Whether the progress was completed.

toString

String toString()

Returns a String representation of the progress suitable as a message for printing to the command line interface.

Overrides:

toString in class Object

See Also:

Object.toString()