Package org.eclipse.mat.util
Class VoidProgressListener
- java.lang.Object
-
- org.eclipse.mat.util.VoidProgressListener
-
- All Implemented Interfaces:
IProgressListener
public class VoidProgressListener extends java.lang.Object implements IProgressListener
Empty implementation ofIProgressListenerwhich is frequently used throughout the snapshot API in ISnapshot to get feedback for long running operations. This implementation does nothing.- See Also:
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
Constructors Constructor Description VoidProgressListener()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbeginTask(java.lang.String name, int totalWork)Does nothing.voiddone()Does nothing.booleanisCanceled()Gets the cancel state.voidsendUserMessage(IProgressListener.Severity severity, java.lang.String message, java.lang.Throwable exception)Does nothingvoidsetCanceled(boolean value)Sets the cancel state.voidsubTask(java.lang.String name)Does nothing.voidworked(int work)Does nothing.
-
-
-
Method Detail
-
beginTask
public void beginTask(java.lang.String name, int totalWork)Does nothing.- Specified by:
beginTaskin interfaceIProgressListener- Parameters:
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 isUNKNOWNthe implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.- See Also:
IProgressListener.beginTask(String, int)
-
done
public void done()
Does nothing.- Specified by:
donein interfaceIProgressListener- See Also:
IProgressListener.done()
-
isCanceled
public boolean isCanceled()
Gets the cancel state.- Specified by:
isCanceledin interfaceIProgressListener- Returns:
trueif cancellation has been requested, andfalseotherwise- See Also:
IProgressListener.isCanceled()
-
setCanceled
public void setCanceled(boolean value)
Sets the cancel state.- Specified by:
setCanceledin interfaceIProgressListener- Parameters:
value-trueindicates that cancelation has been requested (but not necessarily acknowledged);falseclears this flag- See Also:
IProgressListener.setCanceled(boolean)
-
subTask
public void subTask(java.lang.String name)
Does nothing.- Specified by:
subTaskin interfaceIProgressListener- Parameters:
name- the name (or description) of the subtask- See Also:
IProgressListener.subTask(String)
-
worked
public void worked(int work)
Does nothing.- Specified by:
workedin interfaceIProgressListener- Parameters:
work- the number of work units just completed- See Also:
IProgressListener.worked(int)
-
sendUserMessage
public void sendUserMessage(IProgressListener.Severity severity, java.lang.String message, java.lang.Throwable exception)
Does nothing- Specified by:
sendUserMessagein interfaceIProgressListener- Parameters:
severity- Severity as defined inIProgressListener.Severitymessage- The message localized to the current locale.exception- The relevant low-level exception, ornullif none.- See Also:
IProgressListener.sendUserMessage(Severity, String, Throwable)
-
-