Класс ForkJoinPool

public static final ForkJoinPool.ForkJoinWorkerThreadFactory defaultForkJoinWorkerThreadFactory

public ForkJoinPool()

public ForkJoinPool(int parallelism)

Параметры:

parallelism — уровень параллелизма

Исключения:

IllegalArgumentException — если параллелизм меньше или равен нулю либо превышает ограничение реализации

public ForkJoinPool(int parallelism, ForkJoinPool.ForkJoinWorkerThreadFactory factory, Thread.UncaughtExceptionHandler handler, boolean asyncMode)

Параметры:

parallelism — уровень параллелизма. Чтобы использовать значение по умолчанию, укажите Runtime.availableProcessors().

factory — фабрика для создания новых потоков. Чтобы использовать значение по умолчанию, укажите defaultForkJoinWorkerThreadFactory.

handler — обработчик внутренних рабочих потоков, которые завершаются из-за неисправимых ошибок, возникших при выполнении задач. Чтобы использовать значение по умолчанию, укажите null.

asyncMode — если значение равно true, для разделённых задач, к которым никогда не присоединяются, устанавливается локальный режим планирования FIFO. Этот режим может быть предпочтительнее режима по умолчанию на основе локального стека в приложениях, где рабочие потоки обрабатывают только асинхронные задачи, связанные с событиями. Чтобы использовать значение по умолчанию, укажите false.

Исключения:

IllegalArgumentException — если параллелизм меньше или равен нулю либо превышает ограничение реализации

NullPointerException — если фабрика равна null

public ForkJoinPool(int parallelism, ForkJoinPool.ForkJoinWorkerThreadFactory factory, Thread.UncaughtExceptionHandler handler, boolean asyncMode, int corePoolSize, int maximumPoolSize, int minimumRunnable, Predicate<? super ForkJoinPool> saturate, long keepAliveTime, TimeUnit unit)

Параметры:

parallelism — уровень параллелизма. Чтобы использовать значение по умолчанию, укажите Runtime.availableProcessors().

factory — фабрика для создания новых потоков. Чтобы использовать значение по умолчанию, укажите defaultForkJoinWorkerThreadFactory.

handler — обработчик внутренних рабочих потоков, которые завершаются из-за неисправимых ошибок, возникших при выполнении задач. Чтобы использовать значение по умолчанию, укажите null.

asyncMode — если значение равно true, для разделённых задач, к которым никогда не присоединяются, устанавливается локальный режим планирования FIFO. Этот режим может быть предпочтительнее режима по умолчанию на основе локального стека в приложениях, где рабочие потоки обрабатывают только асинхронные задачи, связанные с событиями. Чтобы использовать значение по умолчанию, укажите false.

corePoolSize — игнорируется: использовался в предыдущих выпусках этого класса, но больше не применяется. Использование 0 обеспечивает совместимость между выпусками.

maximumPoolSize — максимально допустимое количество потоков. При достижении максимума попытки заменить заблокированные потоки завершаются неудачей. (Однако из-за того, что создание и завершение разных потоков могут происходить одновременно и управляться указанной фабрикой потоков, это значение может временно превышаться.) Чтобы задать то же значение, которое используется по умолчанию для общего пула, укажите 256 плюс уровень parallelism. (По умолчанию общий пул допускает не более 256 резервных потоков.) Значение (например, Integer.MAX_VALUE), превышающее общий лимит потоков реализации, действует так же, как этот лимит (используемый по умолчанию).

minimumRunnable — минимально допустимое количество основных потоков, не заблокированных вызовом join или ForkJoinPool.ManagedBlocker. Для обеспечения прогресса, когда недостаточно незаблокированных потоков и могут существовать невыполненные задачи, создаются новые потоки — до указанного значения maximumPoolSize. Чтобы использовать значение по умолчанию, обеспечивающее живучесть, укажите 1. Большее значение может повысить пропускную способность при наличии заблокированных операций, но может и не повысить её из-за увеличения накладных расходов. Значение 0 может быть приемлемым, если у отправленных задач нет зависимостей, требующих дополнительных потоков.

saturate — если не равно null, предикат, вызываемый при попытках создать потоки сверх максимально допустимого общего количества. По умолчанию, если поток собирается заблокироваться при вызове join или ForkJoinPool.ManagedBlocker, но его нельзя заменить, так как это приведёт к превышению maximumPoolSize, выбрасывается исключение RejectedExecutionException. Однако, если этот предикат возвращает true, исключение не выбрасывается, и пул продолжает работу с количеством выполняемых потоков меньше целевого, что может не обеспечить прогресс.

keepAliveTime — время с момента последнего использования, по истечении которого поток завершается (а затем при необходимости заменяется). Чтобы использовать значение по умолчанию, укажите 60, TimeUnit.SECONDS.

unit — единица времени для аргумента keepAliveTime

Исключения:

IllegalArgumentException — если параллелизм меньше или равен нулю либо превышает ограничение реализации, если maximumPoolSize меньше параллелизма или если keepAliveTime меньше или равен нулю.

NullPointerException — если фабрика равна null

Начиная с:

9

public static ForkJoinPool commonPool()

Возвращает:

экземпляр общего пула

Начиная с:

1.8

public <T> T invoke(ForkJoinTask<T> task)

Параметры типа:

T — тип результата задачи

Параметры:

task — задача

Возвращает:

результат задачи

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public void execute(ForkJoinTask<?> task)

Параметры:

task — задача

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public void execute(Runnable task)

Определено в:

execute в интерфейсе Executor

Параметры:

task — задача Runnable

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public <T> ForkJoinTask<T> submit(ForkJoinTask<T> task)

Требования к реализации:

Этот метод эквивалентен externalSubmit(ForkJoinTask), если вызывается из потока, не принадлежащего этому пулу.

Параметры типа:

T — тип результата задачи

Параметры:

task — отправляемая задача

Возвращает:

задачу

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public <T> ForkJoinTask<T> submit(Callable<T> task)

Определено в:

submit в интерфейсе ExecutorService

Переопределяет:

submit в классе AbstractExecutorService

Параметры типа:

T — тип результата задачи

Параметры:

task — отправляемая задача

Возвращает:

Future, представляющий ожидающее завершение задачи

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public <T> ForkJoinTask<T> submit(Runnable task, T result)

Определено в:

submit в интерфейсе ExecutorService

Переопределяет:

submit в классе AbstractExecutorService

Параметры типа:

T — тип результата

Параметры:

task — отправляемая задача

result — возвращаемый результат

Возвращает:

Future, представляющий ожидающее завершение задачи

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public ForkJoinTask<?> submit(Runnable task)

Определено в:

submit в интерфейсе ExecutorService

Переопределяет:

submit в классе AbstractExecutorService

Параметры:

task — отправляемая задача

Возвращает:

Future, представляющий ожидающее завершение задачи

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

public <T> ForkJoinTask<T> externalSubmit(ForkJoinTask<T> task)

Требования к реализации:

Этот метод эквивалентен submit(ForkJoinTask), если вызывается из потока, не принадлежащего этому пулу.

Параметры типа:

T — тип результата задачи

Параметры:

task — отправляемая задача

Возвращает:

задачу

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

Начиная с:

20

public <T> ForkJoinTask<T> lazySubmit(ForkJoinTask<T> task)

Параметры типа:

T — тип результата задачи

Параметры:

task — задача

Возвращает:

задачу

Исключения:

NullPointerException — если задача равна null

RejectedExecutionException — если задачу невозможно запланировать для выполнения

Начиная с:

19

public int setParallelism(int size)

Примечание к реализации:

Эта реализация ограничивает максимальное количество работающих потоков значением 32767

Параметры:

size — целевой уровень параллелизма

Возвращает:

предыдущий уровень параллелизма.

Исключения:

IllegalArgumentException — если размер меньше 1 или превышает максимум, поддерживаемый этим пулом.

UnsupportedOperationException — этот пул является commonPool(), а уровень параллелизма задан системным свойством java.util.concurrent.ForkJoinPool.common.parallelism.

Начиная с:

19

public <T> List<Future<T>> invokeAllUninterruptibly(Collection<? extends Callable<T>> tasks)

Примечание к API:

Этот метод поддерживает сценарии использования, которые ранее полагались на несовместимое переопределение ExecutorService.invokeAll(java.util.Collection).

Параметры типа:

T — тип значений, возвращаемых задачами

Параметры:

tasks — коллекция задач

Возвращает:

список объектов Future, представляющих задачи, в том же последовательном порядке, что и итератор указанного списка задач; все задачи в списке завершены

Исключения:

NullPointerException — если задачи или любой из их элементов равны null

RejectedExecutionException — если какую-либо задачу невозможно запланировать для выполнения

Начиная с:

22

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException

Определено в:

invokeAll в интерфейсе ExecutorService

Переопределяет:

invokeAll в классе AbstractExecutorService

Параметры типа:

T — тип значений, возвращаемых задачами

Параметры:

tasks — коллекция задач

Возвращает:

список объектов Future, представляющих задачи, в том же последовательном порядке, что и итератор указанного списка задач; все задачи в списке завершены

Исключения:

InterruptedException — если во время ожидания произошло прерывание; в этом случае незавершённые задачи отменяются

public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException

Определено в:

invokeAll в интерфейсе ExecutorService

Переопределяет:

invokeAll в классе AbstractExecutorService

Параметры типа:

T — тип значений, возвращаемых задачами

Параметры:

tasks — коллекция задач

timeout — максимальное время ожидания

unit — единица времени для аргумента времени ожидания

Возвращает:

список объектов Future, представляющих задачи, в том же последовательном порядке, что и итератор указанного списка задач. Если время ожидания не истекло, все задачи будут завершены. Если оно истекло, некоторые задачи не будут завершены.

Исключения:

InterruptedException — если во время ожидания произошло прерывание; в этом случае незавершённые задачи отменяются

public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException

Определено в:

invokeAny в интерфейсе ExecutorService

Переопределяет:

invokeAny в классе AbstractExecutorService

Параметры типа:

T — тип значений, возвращаемых задачами

Параметры:

tasks — коллекция задач

Возвращает:

результат, возвращённый одной из задач

Исключения:

InterruptedException — если во время ожидания произошло прерывание

ExecutionException — если ни одна задача не завершилась успешно

public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Определено в:

invokeAny в интерфейсе ExecutorService

Переопределяет:

invokeAny в классе AbstractExecutorService

Параметры типа:

T — тип значений, возвращаемых задачами

Параметры:

tasks — коллекция задач

timeout — максимальное время ожидания

unit — единица времени для аргумента времени ожидания

Возвращает:

результат, возвращённый одной из задач

Исключения:

InterruptedException — если во время ожидания произошло прерывание

ExecutionException — если ни одна задача не завершилась успешно

TimeoutException — если указанное время ожидания истекло до успешного завершения какой-либо задачи

public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit)

Определено в:

schedule в интерфейсе ScheduledExecutorService

Параметры:

command — выполняемая задача

delay — задержка выполнения относительно текущего момента

unit — единица времени для параметра задержки

Возвращает:

ForkJoinTask, реализующий интерфейс ScheduledFuture; его метод get() вернёт null при нормальном завершении.

Исключения:

RejectedExecutionException — если пул остановлен или при отправке задачи исчерпаны ресурсы.

NullPointerException — если команда или единица измерения равна null

Начиная с:

25

public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit)

Определено в:

schedule в интерфейсе ScheduledExecutorService

Параметры типа:

V — тип результата Callable

Параметры:

callable — выполняемая функция

delay — задержка выполнения относительно текущего момента

unit — единица времени для параметра задержки

Возвращает:

ForkJoinTask, реализующий интерфейс ScheduledFuture; его метод get() вернёт значение, возвращённое Callable, при нормальном завершении.

Исключения:

RejectedExecutionException — если пул остановлен или при отправке задачи исчерпаны ресурсы.

NullPointerException — если команда или единица измерения равна null

Начиная с:

25

public ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)

Определено в:

scheduleAtFixedRate в интерфейсе ScheduledExecutorService

Параметры:

command - задача для выполнения

initialDelay - время задержки перед первым выполнением

period - период между последовательными выполнениями

unit - единица измерения параметров initialDelay и period

Возвращает:

ForkJoinTask, реализующий интерфейс ScheduledFuture. Метод get() у future никогда не вернётся нормально и выбросит исключение при отмене задачи или ненормальном завершении её выполнения.

Выбрасывает:

RejectedExecutionException - если пул остановлен или при отправке задачи возникает нехватка ресурсов.

NullPointerException - если command или unit равен null

IllegalArgumentException - если period меньше или равен нулю

Начиная с:

25

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)

Определено в:

scheduleWithFixedDelay в интерфейсе ScheduledExecutorService

Параметры:

command - задача для выполнения

initialDelay - время задержки перед первым выполнением

delay - задержка между завершением одного выполнения и началом следующего

unit - единица измерения параметров initialDelay и delay

Возвращает:

ForkJoinTask, реализующий интерфейс ScheduledFuture. Метод get() у future никогда не вернётся нормально и выбросит исключение при отмене задачи или ненормальном завершении её выполнения.

Выбрасывает:

RejectedExecutionException - если пул остановлен или при отправке задачи возникает нехватка ресурсов.

NullPointerException - если command или unit равен null

IllegalArgumentException - если delay меньше или равен нулю

Начиная с:

25

public <V> ForkJoinTask<V> submitWithTimeout(Callable<V> callable, long timeout, TimeUnit unit, Consumer<? super ForkJoinTask<V>> timeoutAction)

Параметры типа:

V - тип результата callable

Параметры:

callable - функция для выполнения

timeout - время ожидания перед отменой, если задача не завершена

unit - единица измерения параметра timeout

timeoutAction - если не равен null, действие при истечении времени ожидания; в противном случае по умолчанию выполняется отмена с помощью cancel(true).

Возвращает:

Future, который можно использовать для получения результата или отмены задачи

Выбрасывает:

RejectedExecutionException - если не удаётся запланировать выполнение задачи

NullPointerException - если callable или unit равен null

Начиная с:

25

public void cancelDelayedTasksOnShutdown()

Начиная с:

25

public ForkJoinPool.ForkJoinWorkerThreadFactory getFactory()

Возвращает:

фабрику, используемую для создания новых рабочих потоков

public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

Возвращает:

обработчик или null, если его нет

public int getParallelism()

Возвращает:

целевой уровень параллелизма этого пула

public static int getCommonPoolParallelism()

Возвращает:

целевой уровень параллелизма общего пула

Начиная с:

1.8

public int getPoolSize()

Возвращает:

количество рабочих потоков

public boolean getAsyncMode()

Возвращает:

true, если этот пул использует асинхронный режим

public int getRunningThreadCount()

Возвращает:

количество рабочих потоков

public int getActiveThreadCount()

Возвращает:

количество активных потоков

public boolean isQuiescent()

Возвращает:

true, если все потоки в данный момент бездействуют

public long getStealCount()

Возвращает:

количество перехватов

public long getQueuedTaskCount()

Возвращает:

количество задач в очередях

См. также:

• ForkJoinWorkerThread.getQueuedTaskCount()

public int getQueuedSubmissionCount()

Возвращает:

количество отправленных задач в очереди

public long getDelayedTaskCount()

Возвращает:

оценку количества отложенных задач

Начиная с:

25

public boolean hasQueuedSubmissions()

Возвращает:

true, если в очереди есть отправленные задачи

protected ForkJoinTask<?> pollSubmission()

Возвращает:

следующую отправленную задачу или null, если такой нет

protected int drainTasksTo(Collection<? super ForkJoinTask<?>> c)

Параметры:

c - коллекция, в которую переносятся элементы

Возвращает:

количество перенесённых элементов

public String toString()

Переопределяет:

toString в классе Object

Возвращает:

строку, идентифицирующую этот пул и его состояние

public void shutdown()

Определено в:

shutdown в интерфейсе ExecutorService

public List<Runnable> shutdownNow()

Определено в:

shutdownNow в интерфейсе ExecutorService

Возвращает:

пустой список

public boolean isTerminated()

Определено в:

isTerminated в интерфейсе ExecutorService

Возвращает:

true, если после остановки все задачи завершились

public boolean isTerminating()

Возвращает:

true, если завершение работы началось, но ещё не закончилось

public boolean isShutdown()

Определено в:

isShutdown в интерфейсе ExecutorService

Возвращает:

true, если работа этого пула остановлена

public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException

Определено в:

awaitTermination в интерфейсе ExecutorService

Параметры:

timeout - максимальное время ожидания

unit - единица измерения аргумента timeout

Возвращает:

true, если работа этого исполнителя завершилась, и false, если время ожидания истекло до завершения работы

Выбрасывает:

InterruptedException - если во время ожидания произошло прерывание

public boolean awaitQuiescence(long timeout, TimeUnit unit)

Параметры:

timeout - максимальное время ожидания

unit - единица измерения аргумента timeout

Возвращает:

true, если пул находится в состоянии покоя; false, если время ожидания истекло.

public void close()

Определено в:

close в интерфейсе AutoCloseable

Определено в:

close в интерфейсе ExecutorService

Начиная с:

19

public static void managedBlock(ForkJoinPool.ManagedBlocker blocker) throws InterruptedException

while (!blocker.isReleasable())
  if (blocker.block())
    break;

Параметры:

blocker - блокирующая задача

Выбрасывает:

InterruptedException - если это сделал blocker.block()