org.sleuthkit.autopsy.progress.TaskCancellable Class Reference

Inherits Cancellable.

Public Member Functions
	TaskCancellable (ProgressIndicator progress)
synchronized boolean	cancel ()
synchronized void	setFuture (Future<?> future)

Private Attributes
Future<?>	future
final ProgressIndicator	progress

Detailed Description

Pluggable cancellation behavior for use in progress indicators (such as the application frame progress indicator) that support cancelling a task using an implementation of org.openide.util.Cancellable. Encapsulates a Future<?> to be cancelled and sets the cancelling flag and message of the progress indicator.

Definition at line 32 of file TaskCancellable.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.progress.TaskCancellable.TaskCancellable

(

ProgressIndicator

progress

)

Constructs a pluggable cancellation behavior for use in progress indicators (such as the application frame progress indicator) that support cancelling a task using an implementation of org.openide.util.Cancellable. Encapsulates a Future<?> to be cancelled and sets the cancelling flag and message of the progress indicator.

Parameters

progress

Definition at line 46 of file TaskCancellable.java.

References org.sleuthkit.autopsy.progress.TaskCancellable.progress.

Member Function Documentation

synchronized boolean org.sleuthkit.autopsy.progress.TaskCancellable.cancel

(

)

Definition at line 63 of file TaskCancellable.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.setCancelling().

synchronized void org.sleuthkit.autopsy.progress.TaskCancellable.setFuture

(

Future<?>

future

)

Sets the Future<?> used to cancel the associated task.

Parameters

future

The future for the associated task.

Definition at line 55 of file TaskCancellable.java.

References org.sleuthkit.autopsy.progress.TaskCancellable.future.

Member Data Documentation

Future<?> org.sleuthkit.autopsy.progress.TaskCancellable.future

private

Definition at line 35 of file TaskCancellable.java.

Referenced by org.sleuthkit.autopsy.progress.TaskCancellable.setFuture().

final ProgressIndicator org.sleuthkit.autopsy.progress.TaskCancellable.progress

private

Definition at line 34 of file TaskCancellable.java.

Referenced by org.sleuthkit.autopsy.progress.TaskCancellable.TaskCancellable().

---

The documentation for this class was generated from the following file:

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/progress/TaskCancellable.java