Package uk.ac.starlink.table.join
Class ProgressTracker
java.lang.Object
uk.ac.starlink.table.join.ProgressTracker
- All Implemented Interfaces:
AutoCloseable
Wraps a ProgressIndicator for sequential usage.
This takes care of messaging a progress indicator periodically
given that the number of iterations is known up front.
This object should not be used from multiple threads concurrently.
- Since:
- 21 Sep 2022
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionProgressTracker
(ProgressIndicator progger, long count, String txt) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Signals that the iteration is finished.void
Registers the next iteration.
-
Constructor Details
-
ProgressTracker
Constructor.- Parameters:
progger
- progress indicatorcount
- number of invocations of progressNext expectedtxt
- stage title to pass to indicator
-
-
Method Details
-
nextProgress
Registers the next iteration. This method is cheap.- Throws:
InterruptedException
-
close
public void close()Signals that the iteration is finished. Must be called to indicate that this tracker will no longer be used.- Specified by:
close
in interfaceAutoCloseable
-