Interface ListenableFuture<V>

    • Method Summary

      Modifier and Type Method and Description
      void addListener(Runnable listener, Executor executor)
      Registers a listener to be run on the given executor.
    • Method Detail

      • addListener

        void addListener(Runnable listener,
                         Executor executor)
        Registers a listener to be run on the given executor. The listener will run when the Future'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., a RejectedExecutionException or an exception thrown by direct execution) will be caught and logged.

        Note: For fast, lightweight listeners that would be safe to execute in any thread, consider MoreExecutors.directExecutor(). Otherwise, avoid it. Heavyweight directExecutor listeners can cause problems, and these problems can be difficult to reproduce because they depend on timing. For example:

        • The listener may be executed by the caller of addListener. That caller may be a UI thread or other latency-sensitive thread. This can harm UI responsiveness.
        • The listener may be executed by the thread that completes this Future. That thread may be an internal system thread such as an RPC network thread. Blocking that thread may stall progress of the whole system. It may even cause a deadlock.
        • The listener may delay other listeners, even listeners that are not themselves directExecutor listeners.

        This is the most general listener interface. For common operations performed using listeners, see Futures. For a simplified but general listener interface, see addCallback().

        Memory consistency effects: Actions in a thread prior to adding a listener happen-before its execution begins, perhaps in another thread.

        Parameters:
        listener - the listener to run when the computation is complete
        executor - the executor to run the listener in
        Throws:
        NullPointerException - if the executor or listener was null
        RejectedExecutionException - if we tried to execute the listener immediately but the executor rejected it.