- All Known Implementing Classes:
ProgressMonitorBasic
,ProgressMonitorOutput
public interface ProgressMonitor
Interface
ProgressMonitor
- monitor progress.-
Method Summary
Modifier and TypeMethodDescriptionvoid
finish()
Finish and stop timing.void
finishMessage
(String message) Output the finishing message.void
Finish a section within the overall start-finish.getLabel()
long
Return the number of ticks.long
Return the elapsed section time taken.long
getTicks()
Return the number of ticks.long
getTime()
Return the elapsed time taken - this is only valid afterfinish()
has been called.void
void
start()
Start and start timing.void
startMessage
(String message) Output the starting message.void
Start a section within the overall start-finish.void
tick()
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.
-