|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.mat.util.SimpleMonitor.Listener
public class SimpleMonitor.Listener
| 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 | |
|---|---|
SimpleMonitor.Listener(int majorUnits)
|
|
| Method Summary | |
|---|---|
void |
beginTask(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. |
long |
getWorkDone()
|
boolean |
isCanceled()
Returns whether cancelation of current operation has been requested. |
boolean |
isProbablyCanceled()
|
void |
sendUserMessage(IProgressListener.Severity severity,
String message,
Throwable exception)
Sends a message to the user. |
void |
setCanceled(boolean value)
Sets the cancel state to the given value. |
void |
subTask(String name)
Notifies that a subtask of the main task is beginning. |
void |
totalWorkDone(long work)
|
void |
worked(int work)
Notifies that a given number of work unit of the main task has been completed. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SimpleMonitor.Listener(int majorUnits)
| Method Detail |
|---|
public void beginTask(String name,
int totalWork)
IProgressListener
beginTask in interface IProgressListenername - 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 subTask(String name)
IProgressListener
subTask in interface IProgressListenername - the name (or description) of the subtaskpublic void done()
IProgressListener
done in interface IProgressListenerpublic boolean isCanceled()
IProgressListener
isCanceled in interface IProgressListenertrue if cancellation has been requested, and
false otherwiseIProgressListener.setCanceled(boolean)public boolean isProbablyCanceled()
public void totalWorkDone(long work)
public void worked(int work)
IProgressListener
worked in interface IProgressListenerwork - the number of work units just completedpublic void setCanceled(boolean value)
IProgressListener
setCanceled in interface IProgressListenervalue - true indicates that cancelation has been
requested (but not necessarily acknowledged);
false clears this flagIProgressListener.isCanceled()
public void sendUserMessage(IProgressListener.Severity severity,
String message,
Throwable exception)
IProgressListener
sendUserMessage in interface IProgressListenerseverity - Severity as defined in IProgressListener.Severitymessage - The message localized to the current locale.exception - The relevant low-level exception, or null if
none.public long getWorkDone()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||