Movatterモバイル変換


[0]ホーム

URL:


          
Java 2 Platform
Standard Ed. 5.0


Class FutureTask<V>

java.lang.Objectextended by java.util.concurrent.FutureTask<V>
Type Parameters:
V - The result type returned by this FutureTask'sget method
All Implemented Interfaces:
Runnable,Future<V>

public classFutureTask<V>
extendsObject
implementsFuture<V>,Runnable

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 method will block if the computation has not yet completed. Once the computation has completed, the computation cannot be restarted or cancelled.

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

FutureTask(Callable<V> callable)
          Creates aFutureTask that will upon running, execute the givenCallable.
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.
 
cancel(boolean mayInterruptIfRunning)
          Attempts to cancel execution of this task.
done()
          Protected method invoked when this task transitions to stateisDone (whether normally or via cancellation).
get()
          Waits if necessary for the computation to complete, and then retrieves its result.
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.
isCancelled()
          Returnstrue if this task was cancelled before it completed normally.
isDone()
          Returnstrue if this task completed.
run()
          Sets this Future to the result of computation unless it has been cancelled.
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.
set(V v)
          Sets the result of this Future to the given value unless this future has already been set or has been cancelled.
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.
 
Methods inherited from class java.lang.Object
clone,equals,finalize,getClass,hashCode,notify,notifyAll,toString,wait,wait,wait
 

FutureTask

publicFutureTask(Callable<V> callable)
Creates aFutureTask that will upon running, execute the givenCallable.

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

FutureTask

publicFutureTask(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<Object>(runnable, null)
Throws:
NullPointerException - if runnable is null

isCancelled

public booleanisCancelled()
Description copied from interface:Future
Returnstrue if this task was cancelled before it completed normally.

Specified by:
isCancelled in interfaceFuture<V>
Returns:
true if task was cancelled before it completed

isDone

public booleanisDone()
Description copied from interface:Future
Returnstrue if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will returntrue.

Specified by:
isDone in interfaceFuture<V>
Returns:
true if this task completed.

cancel

public booleancancel(boolean mayInterruptIfRunning)
Description copied from interface:Future
Attempts 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 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.

Specified by:
cancel in interfaceFuture<V>
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

get

publicVget()      throwsInterruptedException,ExecutionException
Description copied from interface:Future
Waits if necessary for the computation to complete, and then retrieves its result.

Specified by:
get in interfaceFuture<V>
Returns:
the computed result
Throws:
InterruptedException - if the current thread was interrupted while waiting
ExecutionException - if the computation threw an exception

get

publicVget(long timeout,TimeUnit unit)      throwsInterruptedException,ExecutionException,TimeoutException
Description copied from interface:Future
Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Specified by:
get in interfaceFuture<V>
Parameters:
timeout - the maximum time to wait
unit - the time unit of the timeout argument
Returns:
the computed result
Throws:
InterruptedException - if the current thread was interrupted while waiting
ExecutionException - if the computation threw an exception
TimeoutException - if the wait timed out

done

protected voiddone()
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 voidset(V v)
Sets the result of this Future to the given value unless this future has already been set or has been cancelled.

Parameters:
v - the value

setException

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.

Parameters:
t - the cause of failure.

run

public voidrun()
Sets this Future to the result of computation unless it has been cancelled.

Specified by:
run in interfaceRunnable
See Also:
Thread.run()

runAndReset

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. This is designed for use with tasks that intrinsically execute more than once.

Returns:
true if successfully run and reset

          
Java 2 Platform
Standard Ed. 5.0


[8]ページ先頭

©2009-2025 Movatter.jp