V
- The result type returned by this FutureTask's get
methodsRunnable
, Future<V>
, RunnableFuture<V>
public class FutureTask<V> extends Object implements RunnableFuture<V>
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.
Future.State
Constructor | Description |
---|---|
FutureTask |
Creates a FutureTask that will, upon running, execute the given Runnable , and arrange that get will return the given result on successful completion. |
FutureTask |
Creates a FutureTask that will, upon running, execute the given Callable . |
Modifier and Type | Method | Description |
---|---|---|
boolean |
cancel |
Attempts to cancel execution of this task. |
protected void |
done() |
Protected method invoked when this task transitions to state isDone (whether normally or via cancellation). |
V |
get() |
Waits if necessary for the computation to complete, and then retrieves its result. |
V |
get |
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 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. |
protected void |
set |
Sets the result of this future to the given value unless this future has already been set or has been cancelled. |
protected void |
setException |
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. |
String |
toString() |
Returns a string representation of this FutureTask. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
exceptionNow, resultNow, state
public FutureTask(Callable<V> callable)
FutureTask
that will, upon running, execute the given Callable
.callable
- the callable taskNullPointerException
- if the callable is nullpublic FutureTask(Runnable runnable, V result)
FutureTask
that will, upon running, execute the given Runnable
, and arrange that get
will return the given result on successful completion.runnable
- the runnable taskresult
- 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<Void>(runnable, null)
NullPointerException
- if the runnable is nullpublic boolean isCancelled()
Future
true
if this task was cancelled before it completed normally.isCancelled
in interface Future<V>
true
if this task was cancelled before it completedpublic boolean isDone()
Future
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
.public boolean cancel(boolean mayInterruptIfRunning)
Future
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 (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use Future.isCancelled()
.
cancel
in interface Future<V>
mayInterruptIfRunning
- true
if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to completefalse
if the task could not be cancelled, typically because it has already completed; true
otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true
. Implementations may provide stronger guarantees.public V get() throws InterruptedException, ExecutionException
Future
get
in interface Future<V>
CancellationException
- if the computation was cancelledInterruptedException
- if the current thread was interrupted while waitingExecutionException
- if the computation threw an exceptionpublic V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException
Future
get
in interface Future<V>
timeout
- the maximum time to waitunit
- the time unit of the timeout argumentCancellationException
- if the computation was cancelledInterruptedException
- if the current thread was interrupted while waitingExecutionException
- if the computation threw an exceptionTimeoutException
- if the wait timed outprotected void done()
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 void set(V v)
This method is invoked internally by the run()
method upon successful completion of the computation.
v
- the valueprotected void setException(Throwable t)
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.
t
- the cause of failurepublic void run()
RunnableFuture
run
in interface Runnable
run
in interface RunnableFuture<V>
protected boolean runAndReset()
true
if successfully run and resetpublic String toString()
toString
in class Object
"Completed Normally"
, "Completed Exceptionally"
, "Cancelled"
, or
"Not completed"
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/FutureTask.html