Package elki.logging.progress
Interface Progress
-
- All Known Implementing Classes:
AbstractProgress
,FiniteProgress
,IndefiniteProgress
,MutableProgress
,StepProgress
public interface Progress
Generic Progress logging interface.- Since:
- 0.1
- Author:
- Erich Schubert
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringBuilder
appendToBuffer(java.lang.StringBuilder buf)
Serialize a description into a String buffer.boolean
isComplete()
Test whether a progress is complete (and thus doesn't need to be shown anymore)java.lang.String
toString()
Returns a String representation of the progress suitable as a message for printing to the command line interface.
-
-
-
Method Detail
-
appendToBuffer
java.lang.StringBuilder appendToBuffer(java.lang.StringBuilder buf)
Serialize a description into a String buffer.- Parameters:
buf
- Buffer to serialize to- Returns:
- Buffer the data was serialized to.
-
isComplete
boolean isComplete()
Test whether a progress is complete (and thus doesn't need to be shown anymore)- Returns:
- Whether the progress was completed.
-
toString
java.lang.String toString()
Returns a String representation of the progress suitable as a message for printing to the command line interface.- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-