Module imagingbook.common

Package imagingbook.common.util.progress

Class ConsoleProgressMonitor

java.lang.Object

java.lang.Thread

imagingbook.common.util.progress.ProgressMonitor

imagingbook.common.util.progress.ConsoleProgressMonitor

All Implemented Interfaces:

AutoCloseable, Runnable

public class ConsoleProgressMonitor
extends ProgressMonitor

A simple progress monitor that only prints the progress of the monitored target task to the console. See ProgressMonitorExample for a usage example.

See Also:

• ProgressMonitor
• ProgressReporter
• ProgressMonitorExample

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class imagingbook.common.util.progress.ProgressMonitor

DefaultWaitTime

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ConsoleProgressMonitor(ProgressReporter target)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	handleProgress(double progress, long elapsedNanoTime)	Called periodically by the ProgressMonitor thread supplying the current progress value (degree of completion).

Methods inherited from class imagingbook.common.util.progress.ProgressMonitor

getElapsedTime, run, setWaitTime

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, suspend, threadId, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ConsoleProgressMonitor

public ConsoleProgressMonitor(ProgressReporter target)

Constructor.

Parameters:

target - the task (ProgressReporter) to be monitored

Method Details

handleProgress

public void handleProgress(double progress,
 long elapsedNanoTime)

Description copied from class: ProgressMonitor

Called periodically by the ProgressMonitor thread supplying the current progress value (degree of completion). It is up to the implementation what action should be performed, e.g., display the current progress graphically (see e.g. IjProgressBarMonitor).

Specified by:

handleProgress in class ProgressMonitor

Parameters:

progress - the current progress value (degree of completion) in [0,1)

elapsedNanoTime - the time elapsed since this progress monitor was started (in nanoseconds)

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class ProgressMonitor