Класс ExecutorCompletionService<V>

java.lang.Object

java.util.concurrent.ExecutorCompletionService<V>

Параметры типа:: V - тип значений, которые задачи этой службы производят и потребляют

Все реализуемые интерфейсы:: CompletionService<V>

public class ExecutorCompletionService<V> extends Object implements CompletionService<V>

CompletionService, использующая предоставленный Executor для выполнения задач. Этот класс обеспечивает помещение отправленных задач в очередь по завершении; доступ к очереди осуществляется с помощью take. Класс достаточно легковесен, чтобы подходить для временного использования при обработке групп задач.

Примеры использования. Предположим, что у вас есть набор решателей некоторой задачи, каждый из которых возвращает значение некоторого типа Result, и вы хотите запускать их параллельно, обрабатывая результаты тех из них, которые возвращают ненулевое значение, в некотором методе use(Result r). Это можно записать так:

void solve(Executor e,
           Collection<Callable<Result>> solvers)
    throws InterruptedException, ExecutionException {
  CompletionService<Result> cs
      = new ExecutorCompletionService<>(e);
  solvers.forEach(cs::submit);
  for (int i = solvers.size(); i > 0; i--) {
    Result r = cs.take().get();
    if (r != null)
      use(r);
  }
}

Предположим вместо этого, что вы хотите использовать первый ненулевой результат из набора задач, игнорируя задачи, завершившиеся с исключениями, и отменяя все остальные задачи, как только будет готов первый результат:

void solve(Executor e,
           Collection<Callable<Result>> solvers)
    throws InterruptedException {
  CompletionService<Result> cs
      = new ExecutorCompletionService<>(e);
  int n = solvers.size();
  List<Future<Result>> futures = new ArrayList<>(n);
  Result result = null;
  try {
    solvers.forEach(solver -> futures.add(cs.submit(solver)));
    for (int i = n; i > 0; i--) {
      try {
        Result r = cs.take().get();
        if (r != null) {
          result = r;
          break;
        }
      } catch (ExecutionException ignore) {}
    }
  } finally {
    futures.forEach(future -> future.cancel(true));
  }

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

С версии:: 1.5

Краткое описание конструкторов

Конструктор	Описание
`ExecutorCompletionService(Executor executor)`	Создает ExecutorCompletionService, используя предоставленный исполнитель для выполнения базовых задач и `LinkedBlockingQueue` в качестве очереди завершенных задач.
`ExecutorCompletionService(Executor executor, BlockingQueue<Future<V>> completionQueue)`	Создает ExecutorCompletionService, используя предоставленный исполнитель для выполнения базовых задач и предоставленную очередь в качестве очереди завершенных задач.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Future<V>`	`poll()`	Получает и удаляет Future, представляющий следующую завершенную задачу, или `null`, если таких задач нет.
`Future<V>`	`poll(long timeout, TimeUnit unit)`	Получает и удаляет Future, представляющий следующую завершенную задачу; если таких задач пока нет, ожидает их появления не дольше указанного времени.
`Future<V>`	`submit(Runnable task, V result)`	Отправляет задачу Runnable на выполнение и возвращает Future, представляющий эту задачу.
`Future<V>`	`submit(Callable<V> task)`	Отправляет задачу, возвращающую значение, на выполнение и возвращает Future, представляющий ожидаемые результаты этой задачи.
`Future<V>`	`take()`	Получает и удаляет Future, представляющий следующую завершенную задачу; если таких задач пока нет, ожидает их появления.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения указанного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения указанного промежутка реального времени.

Подробное описание конструкторов

ExecutorCompletionService

public ExecutorCompletionService(Executor executor)

Создает ExecutorCompletionService, используя предоставленный исполнитель для выполнения базовых задач и LinkedBlockingQueue в качестве очереди завершенных задач.

Параметры:: executor - используемый исполнитель
Исключения:: NullPointerException - если executor равен null

ExecutorCompletionService

public ExecutorCompletionService(Executor executor, BlockingQueue<Future<V>> completionQueue)

Создает ExecutorCompletionService, используя предоставленный исполнитель для выполнения базовых задач и предоставленную очередь в качестве очереди завершенных задач.

Параметры:: executor - используемый исполнитель; completionQueue - очередь, используемая в качестве очереди завершенных задач; обычно это очередь, предназначенная для использования только этой службой. Эта очередь считается неограниченной: если попытка Queue.add для завершенных задач завершается неудачей, такие задачи невозможно будет получить.
Исключения:: NullPointerException - если executor или completionQueue равны null