Класс 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 — выполняемая задача

Исключения:

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 — если tasks или любой из ее элементов равен null

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

Начиная с версии:

22

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

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

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

Параметры:

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

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

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

Возвращает:

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

Исключения:

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

NullPointerException — если command или unit равен 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 — если command или unit равен 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 — единица измерения времени для параметра тайм-аута

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 — единица измерения времени для аргумента времени ожидания

Возвращает:

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

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

InterruptedException — если поток был прерван во время ожидания

public boolean awaitQuiescence(long timeout, TimeUnit unit)

Параметры:

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

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

Возвращает:

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()