org.eclipse.equinox.concurrent.future

Class FutureProgressMonitor

java.lang.Object

ProgressMonitorWrapper

org.eclipse.equinox.concurrent.future.FutureProgressMonitor

public class FutureProgressMonitor
extends ProgressMonitorWrapper

Progress Monitor for use with future. This progress monitor provides a wrapper for potentially two progress monitors: one provided by the IFuture client in a method call, the other (a child progress monitor) provided by the IExecutor that creates the future instance.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
FutureProgressMonitor(IProgressMonitor progressMonitor) Create a new progress monitor wrapping the given monitor.

Method Summary

Modifier and Type	Method and Description
void	beginTask(java.lang.String name, int totalWork)
void	done()
void	internalWorked(double work)
void	setCanceled(boolean value)
void	setChildProgressMonitor(IProgressMonitor value) Set the client-facing progress monitor to the given value.
void	setTaskName(java.lang.String name)
void	subTask(java.lang.String name)
void	worked(int work)

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureProgressMonitor

public FutureProgressMonitor(IProgressMonitor progressMonitor)

Create a new progress monitor wrapping the given monitor. The nested monitor is the one exposed to clients of futures.

Parameters:

progressMonitor - the client-facing monitor used with a future. May be null.

See Also:

setChildProgressMonitor(IProgressMonitor)

Method Detail

beginTask

public void beginTask(java.lang.String name,
                      int totalWork)

done

public void done()

internalWorked

public void internalWorked(double work)

setCanceled

public void setCanceled(boolean value)

setTaskName

public void setTaskName(java.lang.String name)

subTask

public void subTask(java.lang.String name)

worked

public void worked(int work)

setChildProgressMonitor

public void setChildProgressMonitor(IProgressMonitor value)

Set the client-facing progress monitor to the given value.

Parameters:

value - a second (child) monitor to report progress/take cancelation from. If the parent progress monitor has been previously canceled, the child progress monitor's setCanceled method will be called.