Class ListenableFutureTask<V>
- All Implemented Interfaces:
ListenableFuture<V>,Runnable,Future<V>,RunnableFuture<V>
FutureTask that also implements the ListenableFuture interface. Unlike
FutureTask, ListenableFutureTask does not provide an overrideable done() method. For similar functionality, call addListener(java.lang.Runnable, java.util.concurrent.Executor).
Few users should use this class. It is intended primarily for those who are implementing an
ExecutorService. Most users should call ListeningExecutorService.submit on a service obtained from MoreExecutors.listeningDecorator(java.util.concurrent.ExecutorService).
- Since:
- 1.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionListenableFutureTask(Runnable runnable, V result) ListenableFutureTask(Callable<V> callable) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddListener(Runnable listener, Executor exec) Registers a listener to be run on the given executor.static <V> ListenableFutureTask<V>Creates aListenableFutureTaskthat will upon running, execute the givenRunnable, and arrange thatgetwill return the given result on successful completion.static <V> ListenableFutureTask<V>Creates aListenableFutureTaskthat will upon running, execute the givenCallable.protected voiddone()Internal implementation detail used to invoke the listeners.Methods inherited from class java.util.concurrent.FutureTask
cancel, get, isCancelled, isDone, run, runAndReset, set, setException, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.concurrent.Future
cancel, get, isCancelled, isDone
-
Field Details
-
executionList
-
-
Constructor Details
-
ListenableFutureTask
-
ListenableFutureTask
-
-
Method Details
-
create
Creates aListenableFutureTaskthat will upon running, execute the givenCallable.- Parameters:
callable- the callable task- Since:
- 10.0
-
create
Creates aListenableFutureTaskthat will upon running, execute the givenRunnable, and arrange thatgetwill return the given result on successful completion.- Parameters:
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:ListenableFuture<?> f = ListenableFutureTask.create(runnable, null)- Since:
- 10.0
-
addListener
Description copied from interface:ListenableFutureRegisters a listener to be run on the given executor. The listener will run when theFuture's computation is complete or, if the computation is already complete, immediately.There is no guaranteed ordering of execution of listeners, but any listener added through this method is guaranteed to be called once the computation is complete.
Exceptions thrown by a listener will be propagated up to the executor. Any exception thrown during
Executor.execute(e.g., aRejectedExecutionExceptionor an exception thrown by direct execution) will be caught and logged.Note: If your listener is lightweight -- and will not cause stack overflow by completing more futures or adding more
directExecutor()listeners inline -- considerMoreExecutors.directExecutor(). Otherwise, avoid it: See the warnings on the docs fordirectExecutor.This is the most general listener interface. For common operations performed using listeners, see
Futures. For a simplified but general listener interface, seeaddCallback().Memory consistency effects: Actions in a thread prior to adding a listener happen-before its execution begins, perhaps in another thread.
Guava implementations of
ListenableFuturepromptly release references to listeners after executing them.- Specified by:
addListenerin interfaceListenableFuture<V>- Parameters:
listener- the listener to run when the computation is completeexec- the executor to run the listener in
-
get
public V get(long timeout, TimeUnit unit) throws TimeoutException, InterruptedException, ExecutionException - Specified by:
getin interfaceFuture<V>- Overrides:
getin classFutureTask<V>- Throws:
TimeoutExceptionInterruptedExceptionExecutionException
-
done
protected void done()Internal implementation detail used to invoke the listeners.- Overrides:
donein classFutureTask<V>
-