to top
Android APIs
public class

FutureTask

extends Object
implements RunnableFuture<V>
java.lang.Object
   ↳ java.util.concurrent.FutureTask<V>

Class Overview

A cancellable asynchronous computation. This class provides a base implementation of Future, with methods to start and cancel a computation, query to see if the computation is complete, and retrieve the result of the computation. The result can only be retrieved when the computation has completed; the get methods will block if the computation has not yet completed. Once the computation has completed, the computation cannot be restarted or cancelled (unless the computation is invoked using runAndReset()).

A FutureTask can be used to wrap a Callable or Runnable object. Because FutureTask implements Runnable, a FutureTask can be submitted to an Executor for execution.

In addition to serving as a standalone class, this class provides protected functionality that may be useful when creating customized task classes.

Summary

Public Constructors
FutureTask( Callable<V> callable)
Creates a FutureTask that will, upon running, execute the given Callable.
FutureTask( Runnable runnable, V result)
Creates a FutureTask that will, upon running, execute the given Runnable, and arrange that get will return the given result on successful completion.
Public Methods
boolean cancel(boolean mayInterruptIfRunning)
Attempts to cancel execution of this task.
V get()
Waits if necessary for the computation to complete, and then retrieves its result.
V get(long timeout, TimeUnit unit)
Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
boolean isCancelled()
Returns true if this task was cancelled before it completed normally.
boolean isDone()
Returns true if this task completed.
void run()
Sets this Future to the result of its computation unless it has been cancelled.
Protected Methods
void done()
Protected method invoked when this task transitions to state isDone (whether normally or via cancellation).
boolean runAndReset()
Executes the computation without setting its result, and then resets this future to initial state, failing to do so if the computation encounters an exception or is cancelled.
void set(V v)
Sets the result of this future to the given value unless this future has already been set or has been cancelled.
void setException( Throwable t)
Causes this future to report an ExecutionException with the given throwable as its cause, unless this future has already been set or has been cancelled.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Runnable
From interface java.util.concurrent.Future
From interface java.util.concurrent.RunnableFuture

Public Constructors

public FutureTask (Callable<V> callable)

Added in API level 1

Creates a FutureTask that will, upon running, execute the given Callable.

Parameters
callable the callable task
Throws
NullPointerException if the callable is null

public FutureTask (Runnable runnable, V result)

Added in API level 1

Creates a FutureTask that will, upon running, execute the given Runnable, and arrange that get will return the given result on successful completion.

Parameters
runnable the runnable task
result the result to return on successful completion. If you don't need a particular result, consider using constructions of the form: Future f = new FutureTask (runnable, null)
Throws
NullPointerException if the runnable is null

Public Methods

public boolean cancel (boolean mayInterruptIfRunning)

Added in API level 1

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 when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to isDone() will always return true. Subsequent calls to isCancelled() will always return true if this method returned true.

Parameters
mayInterruptIfRunning true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete
Returns
  • false if the task could not be cancelled, typically because it has already completed normally; true otherwise

public V get ()

Added in API level 1

Waits if necessary for the computation to complete, and then retrieves its result.

Returns
  • the computed result
Throws
CancellationException
InterruptedException
ExecutionException

public V get (long timeout, TimeUnit unit)

Added in API level 1

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters
timeout the maximum time to wait
unit the time unit of the timeout argument
Returns
  • the computed result
Throws
CancellationException
InterruptedException
ExecutionException
TimeoutException

public boolean isCancelled ()

Added in API level 1

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

Returns
  • true if this task was cancelled before it completed

public boolean isDone ()

Added in API level 1

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns
  • true if this task completed

public void run ()

Added in API level 1

Sets this Future to the result of its computation unless it has been cancelled.

Protected Methods

protected void done ()

Added in API level 1

Protected method invoked when this task transitions to state isDone (whether normally or via cancellation). The default implementation does nothing. Subclasses may override this method to invoke completion callbacks or perform bookkeeping. Note that you can query status inside the implementation of this method to determine whether this task has been cancelled.

protected boolean runAndReset ()

Added in API level 1

Executes the computation without setting its result, and then resets this future to initial state, failing to do so if the computation encounters an exception or is cancelled. This is designed for use with tasks that intrinsically execute more than once.

Returns
  • true if successfully run and reset

protected void set (V v)

Added in API level 1

Sets the result of this future to the given value unless this future has already been set or has been cancelled.

This method is invoked internally by the run() method upon successful completion of the computation.

Parameters
v the value

protected void setException (Throwable t)

Added in API level 1

Causes this future to report an ExecutionException with the given throwable as its cause, unless this future has already been set or has been cancelled.

This method is invoked internally by the run() method upon failure of the computation.

Parameters
t the cause of failure
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.