com.bc.ceres.core

Class NullProgressMonitor

java.lang.Object

com.bc.ceres.core.NullProgressMonitor

All Implemented Interfaces:

ProgressMonitor

public class NullProgressMonitor
extends Object
implements ProgressMonitor

A default progress monitor implementation suitable for subclassing.

This implementation supports cancellation. The default implementations of the other methods do nothing.

This class has been more or less directly taken over from the Eclipse Core API.

Field Summary

Fields inherited from interface com.bc.ceres.core.ProgressMonitor

NULL, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
NullProgressMonitor() Constructs a new progress monitor.

Method Summary

Modifier and Type	Method and Description
void	beginTask(String taskName, int totalWork) This implementation does nothing.
void	done() This implementation does nothing.
void	internalWorked(double work) This implementation does nothing.
boolean	isCanceled() This implementation returns the value of the internal state variable set by setCanceled.
void	setCanceled(boolean canceled) This implementation sets the value of an internal state variable.
void	setSubTaskName(String subTaskName) This implementation does nothing.
void	setTaskName(String taskName) This implementation does nothing.
void	worked(int work) This implementation does nothing.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullProgressMonitor

public NullProgressMonitor()

Constructs a new progress monitor.

Method Detail

beginTask

public void beginTask(String taskName,
                      int totalWork)

This implementation does nothing. Subclasses may override this method to do interesting processing when a task begins.

Specified by:

beginTask in interface ProgressMonitor

Parameters:

taskName - the name (or description) of the main task

totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

done

public void done()

This implementation does nothing. Subclasses may override this method to do interesting processing when a task is done.

Specified by:

done in interface ProgressMonitor

internalWorked

public void internalWorked(double work)

This implementation does nothing. Subclasses may override this method.

Specified by:

internalWorked in interface ProgressMonitor

Parameters:

work - the amount of work done

isCanceled

public boolean isCanceled()

This implementation returns the value of the internal state variable set by setCanceled. Subclasses which override this method should override setCanceled as well.

Specified by:

isCanceled in interface ProgressMonitor

Returns:

true if cancellation has been requested, and false otherwise

See Also:

ProgressMonitor.setCanceled(boolean)

setCanceled

public void setCanceled(boolean canceled)

This implementation sets the value of an internal state variable. Subclasses which override this method should override isCanceled as well.

Specified by:

setCanceled in interface ProgressMonitor

Parameters:

canceled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag

See Also:

ProgressMonitor.isCanceled()

setTaskName

public void setTaskName(String taskName)

This implementation does nothing. Subclasses may override this method to do something with the name of the task.

Specified by:

setTaskName in interface ProgressMonitor

Parameters:

taskName - the name (or description) of the main task

See Also:

ProgressMonitor.beginTask(String, int)

setSubTaskName

public void setSubTaskName(String subTaskName)

This implementation does nothing. Subclasses may override this method to do interesting processing when a subtask begins.

Specified by:

setSubTaskName in interface ProgressMonitor

Parameters:

subTaskName - the name (or description) of the subtask

worked

public void worked(int work)

This implementation does nothing. Subclasses may override this method to do interesting processing when some work has been completed.

Specified by:

worked in interface ProgressMonitor

Parameters:

work - the number of work units just completed