public class EclipseJcrMonitor extends java.lang.Object implements JcrMonitor
IProgressMonitor
so that it can be passed to
framework agnostic Argeo routines.UNKNOWN
Constructor and Description |
---|
EclipseJcrMonitor(org.eclipse.core.runtime.IProgressMonitor progressMonitor) |
Modifier and Type | Method and Description |
---|---|
void |
beginTask(java.lang.String name,
int totalWork)
Notifies that the main task is beginning.
|
void |
done()
Notifies that the work is done; that is, either the main task 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 |
setTaskName(java.lang.String name)
Sets the task name to the given value.
|
void |
subTask(java.lang.String name)
Notifies that a subtask of the main task is beginning.
|
void |
worked(int work)
Notifies that a given number of work unit of the main task has been
completed.
|
public EclipseJcrMonitor(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
public void beginTask(java.lang.String name, int totalWork)
JcrMonitor
beginTask
in interface JcrMonitor
name
- the name (or description) of the main tasktotalWork
- 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.public void done()
JcrMonitor
done
in interface JcrMonitor
public boolean isCanceled()
JcrMonitor
isCanceled
in interface JcrMonitor
true
if cancellation has been requested, and
false
otherwiseJcrMonitor.setCanceled(boolean)
public void setCanceled(boolean value)
JcrMonitor
setCanceled
in interface JcrMonitor
value
- true
indicates that cancelation has been
requested (but not necessarily acknowledged);
false
clears this flagJcrMonitor.isCanceled()
public void setTaskName(java.lang.String name)
JcrMonitor
setTaskName
in interface JcrMonitor
name
- the name (or description) of the main taskJcrMonitor.beginTask(java.lang.String, int)
public void subTask(java.lang.String name)
JcrMonitor
subTask
in interface JcrMonitor
name
- the name (or description) of the subtaskpublic void worked(int work)
JcrMonitor
worked
in interface JcrMonitor
work
- a non-negative number of work units just completedCopyright © 2007–2020. All rights reserved.