Cancellable

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> edu >> emory >> mathcs >> util >> [ concurrent overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of edu.emory.mathcs.util.concurrent.Cancellable

SOURCE |

Download edu.emory.mathcs.util.concurrent.Cancellable

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.emory.mathcs.util.concurrent
Interface Cancellable

All Known Implementing Classes:: AsyncTask, CompletedFuture

public interface Cancellable

Something, usually a task, that can be cancelled. Cancellation is performed by the cancel method. Additional methods are provided to determine if the task completed normally or was cancelled.

Since:: 1.5

Method Summary

boolean cancel(boolean mayInterruptIfRunning)
          Attempt to cancel execution of this task.

boolean isCancelled()
          Returns true if this task was cancelled before it completed normally.

boolean isDone()
          Returns true if this task ran to completion or was cancelled.

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Attempt to cancel execution of this task. This attempt will fail if the task has already completed, already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task will never run. If the task has already started, then the interruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

isCancelled

public boolean isCancelled()

Returns true if this task was cancelled before it completed normally.

isDone

public boolean isDone()

Returns true if this task ran to completion or was cancelled.