public interface IProgressMonitorWithBlocking extends IProgressMonitor
When a monitor that supports this extension is passed to an operation, the
operation should call setBlocked
whenever it knows that it
must wait for a lock that is currently held by another thread. The operation
should continue to check for and respond to cancelation requests while
blocked. When the operation is no longer blocked, it must call clearBlocked
to clear the blocked state.
This interface can be used without OSGi running.
Clients may implement this interface.
IProgressMonitor
UNKNOWN
Modifier and Type | Method and Description |
---|---|
void |
clearBlocked()
Clears the blocked state of the running operation.
|
void |
setBlocked(IStatus reason)
Indicates that this operation is blocked by some background activity.
|
beginTask, done, internalWorked, isCanceled, setCanceled, setTaskName, subTask, worked
void setBlocked(IStatus reason)
setBlocked
, it must
eventually call clearBlocked
before the operation
completes.
If the caller is blocked by a currently executing job, this method will return
an IJobStatus
indicating the job that is currently blocking
the caller. If this blocking job is not known, this method will return a plain
informational IStatus
object.
reason
- an optional status object whose message describes the
reason why this operation is blocked, or null
if this
information is not available.clearBlocked()
void clearBlocked()
setBlocked
, it must eventually call
clearBlocked
before the operation completes.setBlocked(IStatus)
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.