Module org.scijava.concurrent

Package org.scijava.concurrent

Class TaskExecutors

java.lang.Object

org.scijava.concurrent.TaskExecutors

public final class TaskExecutors
extends Object

Utility class, with methods to create TaskExecutors.

Method Summary

Modifier and Type	Method	Description
static ThreadFactory	applyTaskExecutorToThreadFactory(Supplier<TaskExecutor> taskExecutorFactory, ThreadFactory threadFactory)	Returns a ThreadFactory.
static TaskExecutor	fixedThreadPool(int numThreads)	Returns a TaskExecutor that uses a fixed thread pool with the given number of threads.
static TaskExecutor	forExecutorService(ExecutorService executorService)	Creates a TaskExecutor that wraps around given ExecutorService.
static TaskExecutor	forExecutorServiceAndNumTasks(ExecutorService executorService, int numTasks)	Creates a TaskExecutor that wraps around given ExecutorService, and will suggest the given number of tasks when asked.
static TaskExecutor	forExecutorServiceAndNumThreads(ExecutorService executorService, int numThreads)	Creates a TaskExecutor that wraps around given ExecutorService, and will return the given parallelism.
static TaskExecutor	multiThreaded()	TaskExecutor for multi-threaded execution.
static TaskExecutor	nestedFixedThreadPool(int numThreads, int numSubThreads)	Returns a TaskExecutor that uses a fixed thread pool with the given number of threads.
static TaskExecutor	numThreads(int numThreads)	TaskExecutor that uses the given number or threads.
static TaskExecutor	singleThreaded()	TaskExecutor for single threaded execution.
static ThreadFactory	threadFactory(Supplier<TaskExecutor> taskExecutorFactory)	Returns a ThreadFactory.

Methods inherited from class java.lang.Object

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

Method Detail

singleThreaded

public static TaskExecutor singleThreaded()

TaskExecutor for single threaded execution.

multiThreaded

public static TaskExecutor multiThreaded()

TaskExecutor for multi-threaded execution. ForkJoinPool is used.

numThreads

public static TaskExecutor numThreads(int numThreads)

TaskExecutor that uses the given number or threads. The TaskExecutor needs to be closed by calling TaskExecutor.close().

forExecutorService

public static TaskExecutor forExecutorService(ExecutorService executorService)

Creates a TaskExecutor that wraps around given ExecutorService.

forExecutorServiceAndNumThreads

public static TaskExecutor forExecutorServiceAndNumThreads(ExecutorService executorService,
                                                           int numThreads)

Creates a TaskExecutor that wraps around given ExecutorService, and will return the given parallelism.

forExecutorServiceAndNumTasks

public static TaskExecutor forExecutorServiceAndNumTasks(ExecutorService executorService,
                                                         int numTasks)

Creates a TaskExecutor that wraps around given ExecutorService, and will suggest the given number of tasks when asked.

fixedThreadPool

public static TaskExecutor fixedThreadPool(int numThreads)

Returns a TaskExecutor that uses a fixed thread pool with the given number of threads.

nestedFixedThreadPool

public static TaskExecutor nestedFixedThreadPool(int numThreads,
                                                 int numSubThreads)

Returns a TaskExecutor that uses a fixed thread pool with the given number of threads. But that's not the end of the story.

Each of the threads uses itself a fixed thread pool with the given number of sub threads.

This TaskExecutor is useful for nested parallelization, when detailed control for the level of parallelism is needed.

threadFactory

public static ThreadFactory threadFactory(Supplier<TaskExecutor> taskExecutorFactory)

Returns a ThreadFactory. Whenever this thread factory is used to create a thread, a TaskExecutor will is create and assigned to the thread. The TaskExecutor is created using the given supplier.

applyTaskExecutorToThreadFactory

public static ThreadFactory applyTaskExecutorToThreadFactory(Supplier<TaskExecutor> taskExecutorFactory,
                                                             ThreadFactory threadFactory)

Returns a ThreadFactory. Whenever this thread factory is used to create a thread, a TaskExecutor will is create and assigned to the thread. The threads created, are using the given thread factory, and the TaskExecutors are create using the given supplier.