Package org.eclipse.mat.util
Class VoidProgressListener
java.lang.Object
org.eclipse.mat.util.VoidProgressListener
- All Implemented Interfaces:
IProgressListener
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.- See Also:
-
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 -
Method Summary
Modifier and TypeMethodDescriptionvoidDoes nothing.voiddone()Does nothing.booleanGets the cancel state.voidsendUserMessage(IProgressListener.Severity severity, String message, Throwable exception) Does nothingvoidsetCanceled(boolean value) Sets the cancel state.voidDoes nothing.voidworked(int work) Does nothing.
-
Constructor Details
-
VoidProgressListener
public VoidProgressListener()
-
-
Method Details
-
beginTask
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:
-
done
public void done()Does nothing.- Specified by:
donein interfaceIProgressListener- See Also:
-
isCanceled
public boolean isCanceled()Gets the cancel state.- Specified by:
isCanceledin interfaceIProgressListener- Returns:
trueif cancellation has been requested, andfalseotherwise- See Also:
-
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:
-
subTask
Does nothing.- Specified by:
subTaskin interfaceIProgressListener- Parameters:
name- the name (or description) of the subtask- See Also:
-
worked
public void worked(int work) Does nothing.- Specified by:
workedin interfaceIProgressListener- Parameters:
work- the number of work units just completed- See Also:
-
sendUserMessage
public void sendUserMessage(IProgressListener.Severity severity, String message, 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:
-