- All Known Implementing Classes:
ProgressMonitorBasic,ProgressMonitorOutput
public interface ProgressMonitor
Interface
ProgressMonitor - monitor progress.-
Method Summary
Modifier and TypeMethodDescriptionvoidfinish()Finish and stop timing.voidfinishMessage(String message) Output the finishing message.voidFinish a section within the overall start-finish.getLabel()longReturn the number of ticks.longReturn the elapsed section time taken.longgetTicks()Return the number of ticks.longgetTime()Return the elapsed time taken - this is only valid afterfinish()has been called.voidvoidstart()Start and start timing.voidstartMessage(String message) Output the starting message.voidStart a section within the overall start-finish.voidtick()Something happened
-
Method Details
-
startMessage
Output the starting message. The format is implementation dependent. -
finishMessage
Output the finishing message. The format is implementation dependent. -
getLabel
String getLabel() -
setLabel
-
start
void start()Start and start timing. This should be paired with a call tofinish(). -
startSection
void startSection()Start a section within the overall start-finish. -
finishSection
void finishSection()Finish a section within the overall start-finish. -
finish
void finish()Finish and stop timing. The total time is available withgetTime()and the number of items processes withgetTicks(). -
tick
void tick()Something happened -
getTicks
long getTicks()Return the number of ticks. Valid afterstart()has been called. -
getTime
long getTime()Return the elapsed time taken - this is only valid afterfinish()has been called. -
getSectionTicks
long getSectionTicks()Return the number of ticks. Valid afterstartSection()has been called. -
getSectionTime
long getSectionTime()Return the elapsed section time taken.
-