Module imagingbook.common

Package imagingbook.common.ij

Class IjProgressBarMonitor

java.lang.Object

java.lang.Thread

imagingbook.common.util.progress.ProgressMonitor

imagingbook.common.ij.IjProgressBarMonitor

All Implemented Interfaces:

AutoCloseable, Runnable

public class IjProgressBarMonitor
extends ProgressMonitor

Implementation of ProgressMonitor which periodically polls the completion state of the associated target task (ProgressReporter) and sends this information to ImageJ's progress bar (if ImageJ is running).

Version:

2022/09/07

See Also:

• ProgressReporter
• ProgressMonitor

Nested Class Summary

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

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
IjProgressBarMonitor(ProgressReporter target)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	handleProgress(double progress, long nanoTime)	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, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Details

IjProgressBarMonitor

public IjProgressBarMonitor(ProgressReporter target)

Constructor.

Parameters:

target - the target task (ProgressReporter) to be monitored

Method Details

handleProgress

public void handleProgress(double progress,
 long nanoTime)

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)

nanoTime - 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