All Known Implementing Classes:

ExecutorCompletionService

public interface CompletionService<V>

• Method Summary

  Methods

  Modifier and Type	Method and Description
  Future<V>	poll () Retrieves and removes the Future representing the next completed task or null if none are present.
  Future<V>	poll (long timeout, TimeUnit unit) Retrieves and removes the Future representing the next completed task, waiting if necessary up to the specified wait time if none are yet present.
  Future<V>	submit (Callable<V> task) Submits a value-returning task for execution and returns a Future representing the pending results of the task.
  Future<V>	submit (Runnable task, V result) Submits a Runnable task for execution and returns a Future representing that task.
  Future<V>	take () Retrieves and removes the Future representing the next completed task, waiting if none are yet present.

• Method Detail

  • submit

    Future<V> submit(Callable<V> task)

    Submits a value-returning task for execution and returns a Future representing the pending results of the task. Upon completion, this task may be taken or polled.

    Parameters:

    task - the task to submit

    Returns:

    a Future representing pending completion of the task

    Throws:

    RejectedExecutionException - if the task cannot be scheduled for execution

    NullPointerException - if the task is null

  • submit

    Future<V> submit(Runnable task,
     V result)

    Submits a Runnable task for execution and returns a Future representing that task. Upon completion, this task may be taken or polled.

    Parameters:

    task - the task to submit

    result - the result to return upon successful completion

    Returns:

    a Future representing pending completion of the task, and whose get() method will return the given result value upon completion

    Throws:

    RejectedExecutionException - if the task cannot be scheduled for execution

    NullPointerException - if the task is null

  • take

    Future<V> take()
     throws InterruptedException 

    Retrieves and removes the Future representing the next completed task, waiting if none are yet present.

    Returns:

    the Future representing the next completed task

    Throws:

    InterruptedException - if interrupted while waiting

  • poll

    Future<V> poll()

    Retrieves and removes the Future representing the next completed task or null if none are present.

    Returns:

    the Future representing the next completed task, or null if none are present

  • poll

    Future<V> poll(long timeout,
     TimeUnit unit)
     throws InterruptedException 

    Retrieves and removes the Future representing the next completed task, waiting if necessary up to the specified wait time if none are yet present.

    Parameters:

    timeout - how long to wait before giving up, in units of unit

    unit - a TimeUnit determining how to interpret the timeout parameter

    Returns:

    the Future representing the next completed task or null if the specified waiting time elapses before one is present

    Throws:

    InterruptedException - if interrupted while waiting