CompletionService (Java 2 Platform SE 5.0) (original) (raw)

java.util.concurrent

Interface CompletionService

All Known Implementing Classes:

public interface CompletionService

A service that decouples the production of new asynchronous tasks from the consumption of the results of completed tasks. Producerssubmit tasks for execution. Consumers take completed tasks and process their results in the order they complete. A CompletionService can for example be used to manage asynchronous IO, in which tasks that perform reads are submitted in one part of a program or system, and then acted upon in a different part of the program when the reads complete, possibly in a different order than they were requested.

Typically, a CompletionService relies on a separate Executor to actually execute the tasks, in which case theCompletionService only manages an internal completion queue. The ExecutorCompletionService class provides an implementation of this approach.

Method Summary
Future<V>	poll() Retrieves and removes the Future representing the next completed task or null if none are present.
Future<V>	[poll](../../../java/util/concurrent/CompletionService.html#poll%28long, java.util.concurrent.TimeUnit%29)(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](../../../java/util/concurrent/CompletionService.html#submit%28java.lang.Runnable, V%29)(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.
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](../../../java/util/concurrent/RejectedExecutionException.html "class in java.util.concurrent") - if task cannot be scheduled for execution

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if task 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](../../../java/util/concurrent/RejectedExecutionException.html "class in java.util.concurrent") - if task cannot be scheduled for execution

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if task 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](../../../java/lang/InterruptedException.html "class in java.lang") - 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, ornull 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 ofunit

unit - a TimeUnit determining how to interpret thetimeout parameter

Returns:

the Future representing the next completed task ornull if the specified waiting time elapses before one is present.

Throws:

[InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang") - if interrupted while waiting.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.