Package ghidra.util.task

Class UnknownProgressWrappingTaskMonitor

java.lang.Object

ghidra.util.task.TaskMonitorAdapter

ghidra.util.task.UnknownProgressWrappingTaskMonitor

All Implemented Interfaces:

TaskMonitor

public class UnknownProgressWrappingTaskMonitor
extends TaskMonitorAdapter

A class that is meant to wrap a TaskMonitor when you do not know the maximum value of the progress.

Field Summary

Fields inherited from class ghidra.util.task.TaskMonitorAdapter

DUMMY_MONITOR

Fields inherited from interface ghidra.util.task.TaskMonitor

DUMMY, NO_PROGRESS_VALUE

Constructor Summary

Constructors

Constructor	Description
UnknownProgressWrappingTaskMonitor(TaskMonitor delegate, long startMaximum)

Method Summary

Modifier and Type	Method	Description
void	checkCanceled()	Check to see if this monitor has been canceled
void	incrementProgress(long incrementAmount)	A convenience method to increment the current progress by the given value
boolean	isCancelled()	Returns true if the user has cancelled the operation
void	setMessage(java.lang.String message)	Sets the message displayed on the task monitor
void	setProgress(long value)	Sets the current progress value

Methods inherited from class ghidra.util.task.TaskMonitorAdapter

addCancelledListener, cancel, clearCanceled, getMaximum, getMessage, getMinimum, getProgress, initialize, isCancelEnabled, isIndeterminate, notifyChangeListeners, removeCancelledListener, setCancelEnabled, setIndeterminate, setMaximum, setMinimum, setShowProgressValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnknownProgressWrappingTaskMonitor

public UnknownProgressWrappingTaskMonitor(TaskMonitor delegate,
                                          long startMaximum)

Method Detail

setMessage

public void setMessage(java.lang.String message)

Description copied from interface: TaskMonitor

Sets the message displayed on the task monitor

Specified by:

setMessage in interface TaskMonitor

Overrides:

setMessage in class TaskMonitorAdapter

Parameters:

message - the message to display

setProgress

public void setProgress(long value)

Description copied from interface: TaskMonitor

Sets the current progress value

Specified by:

setProgress in interface TaskMonitor

Overrides:

setProgress in class TaskMonitorAdapter

Parameters:

value - progress value

incrementProgress

public void incrementProgress(long incrementAmount)

Description copied from interface: TaskMonitor

A convenience method to increment the current progress by the given value

Specified by:

incrementProgress in interface TaskMonitor

Overrides:

incrementProgress in class TaskMonitorAdapter

Parameters:

incrementAmount - The amount by which to increment the progress

isCancelled

public boolean isCancelled()

Description copied from interface: TaskMonitor

Returns true if the user has cancelled the operation

Specified by:

isCancelled in interface TaskMonitor

Overrides:

isCancelled in class TaskMonitorAdapter

Returns:

true if the user has cancelled the operation

checkCanceled

public void checkCanceled()
                   throws CancelledException

Description copied from interface: TaskMonitor

Check to see if this monitor has been canceled

Specified by:

checkCanceled in interface TaskMonitor

Overrides:

checkCanceled in class TaskMonitorAdapter

Throws:

CancelledException - if monitor has been cancelled