Module java.base
Package java.util.concurrent

Class FutureTask<V>

  • Type Parameters:
    V - The result type returned by this FutureTask'sget methods
    All Implemented Interfaces:
    Runnable,Future<V>,RunnableFuture<V>
    public classFutureTask<V>extendsObjectimplementsRunnableFuture<V>
    A cancellable asynchronous computation. This class provides a base implementation ofFuture, 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; theget 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 usingrunAndReset()).

    AFutureTask can be used to wrap aCallable orRunnable object. BecauseFutureTask implementsRunnable, aFutureTask can be submitted to anExecutor for execution.

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

    Since:
    1.5

    • Constructor Summary

      Constructors 
      ConstructorDescription
      FutureTask​(Runnable runnable,V result)
      Creates aFutureTask that will, upon running, execute the givenRunnable, and arrange thatget will return the given result on successful completion.
      FutureTask​(Callable<V> callable)
      Creates aFutureTask that will, upon running, execute the givenCallable.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected voiddone()
      Protected method invoked when this task transitions to stateisDone (whether normally or via cancellation).
      Vget()
      Waits if necessary for the computation to complete, and then retrieves its result.
      Vget​(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.
      protected booleanrunAndReset()
      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 voidset​(V v)
      Sets the result of this future to the given value unless this future has already been set or has been cancelled.
      protected voidsetException​(Throwable t)
      Causes this future to report anExecutionException with the given throwable as its cause, unless this future has already been set or has been cancelled.
      StringtoString()
      Returns a string representation of this FutureTask.

    • Constructor Detail

      • FutureTask

        public FutureTask​(Callable<V> callable)
        Creates aFutureTask that will, upon running, execute the givenCallable.
        Parameters:
        callable - the callable task
        Throws:
        NullPointerException - if the callable is null

      • FutureTask

        public FutureTask​(Runnable runnable,V result)
        Creates aFutureTask that will, upon running, execute the givenRunnable, and arrange thatget 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<Void>(runnable, null)
        Throws:
        NullPointerException - if the runnable is null

    • Method Detail

      • done

        protected void done()
        Protected method invoked when this task transitions to stateisDone (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.

      • set

        protected 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.

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

        Parameters:
        v - the value

      • setException

        protected void setException​(Throwable t)
        Causes this future to report anExecutionException with the given throwable as its cause, unless this future has already been set or has been cancelled.

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

        Parameters:
        t - the cause of failure

      • runAndReset

        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. This is designed for use with tasks that intrinsically execute more than once.
        Returns:
        true if successfully run and reset

      • toString

        public String toString()
        Returns a string representation of this FutureTask.
        Overrides:
        toString in class Object
        Implementation Requirements:
        The default implementation returns a string identifying this FutureTask, as well as its completion state. The state, in brackets, contains one of the strings"Completed Normally","Completed Exceptionally","Cancelled", or "Not completed".
        Returns:
        a string representation of this FutureTask