|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sodius.mdw.core.util.progress.NullProgressMonitor
public class NullProgressMonitor
A default progress monitor implementation suitable for subclassing.
This implementation supports cancelation. The default implementations of the other methods do nothing.
Clients may instantiate or subclass this class.
| Field Summary |
|---|
| Fields inherited from interface com.sodius.mdw.core.util.progress.ProgressMonitor |
|---|
UNKNOWN |
| Constructor Summary | |
|---|---|
NullProgressMonitor()
|
|
| Method Summary | |
|---|---|
void |
beginTask(String name,
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 cancelled)
This implementation sets the value of an internal state variable. |
void |
setTaskName(String name)
This implementation does nothing. |
void |
subTask(String name)
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 |
|---|
public NullProgressMonitor()
| Method Detail |
|---|
public void beginTask(String name,
int totalWork)
beginTask in interface ProgressMonitorname - 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.ProgressMonitor.beginTask(String, int)public void done()
done in interface ProgressMonitorProgressMonitor.done()public void internalWorked(double work)
internalWorked in interface ProgressMonitorwork - the amount of work doneProgressMonitor.internalWorked(double)public boolean isCanceled()
setCanceled.
Subclasses which override this method should
override setCanceled as well.
isCanceled in interface ProgressMonitortrue if cancellation has been requested,
and false otherwiseProgressMonitor.isCanceled(),
ProgressMonitor.setCanceled(boolean)public void setCanceled(boolean cancelled)
isCanceled as well.
setCanceled in interface ProgressMonitorcancelled - true indicates that cancelation has
been requested (but not necessarily acknowledged);
false clears this flagProgressMonitor.isCanceled(),
ProgressMonitor.setCanceled(boolean)public void setTaskName(String name)
setTaskName in interface ProgressMonitorname - the name (or description) of the main taskProgressMonitor.setTaskName(String)public void subTask(String name)
subTask in interface ProgressMonitorname - the name (or description) of the subtaskProgressMonitor.subTask(String)public void worked(int work)
worked in interface ProgressMonitorwork - the number of work units just completedProgressMonitor.worked(int)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||