|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mat.util.VoidProgressListener
public class VoidProgressListener
Empty implementation of IProgressListener
which is frequently used
throughout the snapshot API in ISnapshot to get feedback for long running
operations. This implementation does nothing.
IProgressListener
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.eclipse.mat.util.IProgressListener |
---|
IProgressListener.OperationCanceledException, IProgressListener.Severity |
Field Summary |
---|
Fields inherited from interface org.eclipse.mat.util.IProgressListener |
---|
UNKNOWN_TOTAL_WORK |
Constructor Summary | |
---|---|
VoidProgressListener()
|
Method Summary | |
---|---|
void |
beginTask(String name,
int totalWork)
Does nothing. |
void |
done()
Does nothing. |
boolean |
isCanceled()
Gets the cancel state. |
void |
sendUserMessage(IProgressListener.Severity severity,
String message,
Throwable exception)
Does nothing |
void |
setCanceled(boolean value)
Sets the cancel state. |
void |
subTask(String name)
Does nothing. |
void |
worked(int work)
Does nothing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VoidProgressListener()
Method Detail |
---|
public void beginTask(String name, int totalWork)
beginTask
in interface IProgressListener
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.IProgressListener.beginTask(String, int)
public void done()
done
in interface IProgressListener
IProgressListener.done()
public boolean isCanceled()
isCanceled
in interface IProgressListener
true
if cancellation has been requested, and
false
otherwiseIProgressListener.isCanceled()
public void setCanceled(boolean value)
setCanceled
in interface IProgressListener
value
- true
indicates that cancelation has been
requested (but not necessarily acknowledged);
false
clears this flagIProgressListener.setCanceled(boolean)
public void subTask(String name)
subTask
in interface IProgressListener
name
- the name (or description) of the subtaskIProgressListener.subTask(String)
public void worked(int work)
worked
in interface IProgressListener
work
- the number of work units just completedIProgressListener.worked(int)
public void sendUserMessage(IProgressListener.Severity severity, String message, Throwable exception)
sendUserMessage
in interface IProgressListener
severity
- Severity as defined in IProgressListener.Severity
message
- The message localized to the current locale.exception
- The relevant low-level exception, or null
if
none.IProgressListener.sendUserMessage(Severity, String, Throwable)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |