org.mmbase.util.externalprocess

Class AbstractMonitor

java.lang.Object

org.mmbase.util.externalprocess.AbstractMonitor

All Implemented Interfaces:

IProgressMonitor

public abstract class AbstractMonitor
extends Object
implements IProgressMonitor

Basic implementation of IProgressMonitor that implements every method in the most straight forward or empty way.

Since:

MMBase-1.9.1

Version:

$Id: IProgressMonitor.java 34900 2009-05-01 16:29:42Z michiel $

Author:

Michiel Meeuwissen

Constructor Summary

Constructors

Constructor and Description
AbstractMonitor()

Method Summary

Modifier and Type	Method and Description
void	begin() Notifies that the processing is beginning.
void	done() Notifies that the work is done; that is, either the external process is completed or the user canceled it.
boolean	isCanceled() Returns whether cancelation of current operation has been requested.
void	setCanceled(boolean value) Sets the cancel state to the given value.
void	worked() Notifies that some work of the external process has been completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMonitor

public AbstractMonitor()

Method Detail

begin

public void begin()

Description copied from interface: IProgressMonitor

Notifies that the processing is beginning. This must only be called once on a given progress monitor instance.

Specified by:

begin in interface IProgressMonitor

done

public void done()

Description copied from interface: IProgressMonitor

Notifies that the work is done; that is, either the external process is completed or the user canceled it.

Specified by:

done in interface IProgressMonitor

isCanceled

public boolean isCanceled()

Description copied from interface: IProgressMonitor

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Specified by:

isCanceled in interface IProgressMonitor

Returns:

true if cancellation has been requested, and false otherwise

See Also:

IProgressMonitor.setCanceled(boolean)

setCanceled

public void setCanceled(boolean value)

Description copied from interface: IProgressMonitor

Sets the cancel state to the given value.

Specified by:

setCanceled in interface IProgressMonitor

Parameters:

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

See Also:

IProgressMonitor.isCanceled()

worked

public void worked()

Description copied from interface: IProgressMonitor

Notifies that some work of the external process has been completed.

Specified by:

worked in interface IProgressMonitor