FileDocCategorySizeDatePackage
ExecutorCompletionService.javaAPI DocJava SE 6 API6024Tue Jun 10 00:25:56 BST 2008java.util.concurrent

ExecutorCompletionService

public class ExecutorCompletionService extends Object implements CompletionService
A {@link CompletionService} that uses a supplied {@link Executor} to execute tasks. This class arranges that submitted tasks are, upon completion, placed on a queue accessible using take. The class is lightweight enough to be suitable for transient use when processing groups of tasks.

Usage Examples. Suppose you have a set of solvers for a certain problem, each returning a value of some type Result, and would like to run them concurrently, processing the results of each of them that return a non-null value, in some method use(Result r). You could write this as:

void solve(Executor e,
Collection<Callable<Result>> solvers)
throws InterruptedException, ExecutionException {
CompletionService<Result> ecs
= new ExecutorCompletionService<Result>(e);
for (Callable<Result> s : solvers)
ecs.submit(s);
int n = solvers.size();
for (int i = 0; i < n; ++i) {
Result r = ecs.take().get();
if (r != null)
use(r);
}
}
Suppose instead that you would like to use the first non-null result of the set of tasks, ignoring any that encounter exceptions, and cancelling all other tasks when the first one is ready:
void solve(Executor e,
Collection<Callable<Result>> solvers)
throws InterruptedException {
CompletionService<Result> ecs
= new ExecutorCompletionService<Result>(e);
int n = solvers.size();
List<Future<Result>> futures
= new ArrayList<Future<Result>>(n);
Result result = null;
try {
for (Callable<Result> s : solvers)
futures.add(ecs.submit(s));
for (int i = 0; i < n; ++i) {
try {
Result r = ecs.take().get();
if (r != null) {
result = r;
break;
}
} catch (ExecutionException ignore) {}
}
}
finally {
for (Future<Result> f : futures)
f.cancel(true);
}

if (result != null)
use(result);
}

Fields Summary
private final Executor
executor
private final AbstractExecutorService
aes
private final BlockingQueue
completionQueue
Constructors Summary
public ExecutorCompletionService(Executor executor)
Creates an ExecutorCompletionService using the supplied executor for base task execution and a {@link LinkedBlockingQueue} as a completion queue.

param
executor the executor to use
throws
NullPointerException if executor is null

        if (executor == null)
            throw new NullPointerException();
        this.executor = executor;
        this.aes = (executor instanceof AbstractExecutorService) ?
            (AbstractExecutorService) executor : null;
        this.completionQueue = new LinkedBlockingQueue<Future<V>>();
    
public ExecutorCompletionService(Executor executor, BlockingQueue completionQueue)
Creates an ExecutorCompletionService using the supplied executor for base task execution and the supplied queue as its completion queue.

param
executor the executor to use
param
completionQueue the queue to use as the completion queue normally one dedicated for use by this service
throws
NullPointerException if executor or completionQueue are null

        if (executor == null || completionQueue == null)
            throw new NullPointerException();
        this.executor = executor;
        this.aes = (executor instanceof AbstractExecutorService) ?
            (AbstractExecutorService) executor : null;
        this.completionQueue = completionQueue;
    
Methods Summary
private java.util.concurrent.RunnableFuturenewTaskFor(java.util.concurrent.Callable task)

        if (aes == null)
            return new FutureTask<V>(task);
        else
            return aes.newTaskFor(task);
    
private java.util.concurrent.RunnableFuturenewTaskFor(java.lang.Runnable task, V result)

        if (aes == null)
            return new FutureTask<V>(task, result);
        else
            return aes.newTaskFor(task, result);
    
public java.util.concurrent.Futurepoll()

        return completionQueue.poll();
    
public java.util.concurrent.Futurepoll(long timeout, java.util.concurrent.TimeUnit unit)

        return completionQueue.poll(timeout, unit);
    
public java.util.concurrent.Futuresubmit(java.util.concurrent.Callable task)

        if (task == null) throw new NullPointerException();
        RunnableFuture<V> f = newTaskFor(task);
        executor.execute(new QueueingFuture(f));
        return f;
    
public java.util.concurrent.Futuresubmit(java.lang.Runnable task, V result)

        if (task == null) throw new NullPointerException();
        RunnableFuture<V> f = newTaskFor(task, result);
        executor.execute(new QueueingFuture(f));
        return f;
    
public java.util.concurrent.Futuretake()

        return completionQueue.take();