- All Known Implementing Classes:
Fiber
public interface Cancelable
Interface for tasks that may be cancelled
- Since:
- 2.2.6
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cancel
(boolean mayInterruptIfRunning) Attempts to cancel execution of this task.
-
Method Details
-
cancel
void cancel(boolean mayInterruptIfRunning) Attempts to cancel execution of this task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started whencancel
is called, this task should never run. If the task has already started, then themayInterruptIfRunning
parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.- Parameters:
mayInterruptIfRunning
-true
if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete
-