Package org.eclipse.mat.util
Class VoidProgressListener
- java.lang.Object
-
- org.eclipse.mat.util.VoidProgressListener
-
- All Implemented Interfaces:
IProgressListener
public class VoidProgressListener extends Object implements IProgressListener
Empty implementation ofIProgressListener
which 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 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 nothingvoid
setCanceled(boolean value)
Sets the cancel state.void
subTask(String name)
Does nothing.void
worked(int work)
Does nothing.
-
-
-
Method Detail
-
beginTask
public void beginTask(String name, int totalWork)
Does nothing.- Specified by:
beginTask
in 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 isUNKNOWN
the 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:
done
in interfaceIProgressListener
- See Also:
IProgressListener.done()
-
isCanceled
public boolean isCanceled()
Gets the cancel state.- Specified by:
isCanceled
in interfaceIProgressListener
- Returns:
true
if cancellation has been requested, andfalse
otherwise- See Also:
IProgressListener.isCanceled()
-
setCanceled
public void setCanceled(boolean value)
Sets the cancel state.- Specified by:
setCanceled
in interfaceIProgressListener
- Parameters:
value
-true
indicates that cancelation has been requested (but not necessarily acknowledged);false
clears this flag- See Also:
IProgressListener.setCanceled(boolean)
-
subTask
public void subTask(String name)
Does nothing.- Specified by:
subTask
in 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:
worked
in interfaceIProgressListener
- Parameters:
work
- the number of work units just completed- See Also:
IProgressListener.worked(int)
-
sendUserMessage
public void sendUserMessage(IProgressListener.Severity severity, String message, Throwable exception)
Does nothing- Specified by:
sendUserMessage
in interfaceIProgressListener
- Parameters:
severity
- Severity as defined inIProgressListener.Severity
message
- The message localized to the current locale.exception
- The relevant low-level exception, ornull
if none.- See Also:
IProgressListener.sendUserMessage(Severity, String, Throwable)
-
-