net.sf.ij_plugins.util.progress

Class DefaultProgressReporter

java.lang.Object

net.sf.ij_plugins.util.progress.DefaultProgressReporter

All Implemented Interfaces:

ProgressReporter

Direct Known Subclasses:

ExportAsSTL, MaximumEntropyMultiThreshold, ProgressAccumulator, SRG, SRG2DVector, SRG3D

public class DefaultProgressReporter
extends java.lang.Object
implements ProgressReporter

Default implementation of ProgressReporter interface. Can be used as a base class for implementing ProgressReporter interface. Alternatively, it can be instantiated and used as a help object to manage and notify listeners of a ProgressEvent.

Author:

Jarek Sacha

Constructor Summary

Constructors

Constructor and Description
DefaultProgressReporter()

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener l) Add progress listener.
double	currentProgress() Report what fraction of the processing task was already completed.
protected void	notifyProgressListeners() Notify listeners of current value of progress.
protected void	notifyProgressListeners(double progress) Set new progress value and notify listeners.
protected void	notifyProgressListeners(double progress, java.lang.String message) Set new progress value and notify listeners.
void	removeAllProgressListener() Remove all progress listener.
void	removeProgressListener(ProgressListener l) Remove progress listener.
protected void	setCurrentProgress(double progress) Update value of currentProgress, value must be not less than 0 and not more than 1.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProgressReporter

public DefaultProgressReporter()

Method Detail

currentProgress

public double currentProgress()

Description copied from interface: ProgressReporter

Report what fraction of the processing task was already completed. Progress value is between 0 and 1 (meaning 100% completed). For instance, 0.25 means that 25% con the processing was completed.

Specified by:

currentProgress in interface ProgressReporter

Returns:

current progress.

addProgressListener

public void addProgressListener(ProgressListener l)

Description copied from interface: ProgressReporter

Add progress listener.

Specified by:

addProgressListener in interface ProgressReporter

Parameters:

l - listener to add.

removeProgressListener

public void removeProgressListener(ProgressListener l)

Description copied from interface: ProgressReporter

Remove progress listener.

Specified by:

removeProgressListener in interface ProgressReporter

Parameters:

l - listener to remove.

removeAllProgressListener

public void removeAllProgressListener()

Description copied from interface: ProgressReporter

Remove all progress listener.

Specified by:

removeAllProgressListener in interface ProgressReporter

setCurrentProgress

protected void setCurrentProgress(double progress)

Update value of currentProgress, value must be not less than 0 and not more than 1.

This method is used when progress needs to be updated without notifying the listeners. To update progress and update listeners use notifyProgressListeners(double).

Parameters:

progress - new value of currentProgress. The value must be not less than 0 and not more than 1.

See Also:

notifyProgressListeners(), notifyProgressListeners(double), notifyProgressListeners(double, String)

notifyProgressListeners

protected void notifyProgressListeners()

Notify listeners of current value of progress. Progress message is an empty string.

See Also:

notifyProgressListeners(double)

notifyProgressListeners

protected void notifyProgressListeners(double progress)

Set new progress value and notify listeners. A convenience method that can be used instead calling setCurrentProgress(double) and notifyProgressListeners(). Progress message is an empty string.

Parameters:

progress - new value of currentProgress. The value must be not less than 0 and not more than 1.

See Also:

setCurrentProgress(double), notifyProgressListeners()

notifyProgressListeners

protected void notifyProgressListeners(double progress,
                           java.lang.String message)

Set new progress value and notify listeners.

Parameters:

progress - new value of currentProgress. The value must be not less than 0 and not more than 1.

message - message that will be send to listeners within {#link ProgressEvent}