Class SequentialTaskExecutor

java.lang.Object

net.imglib2.parallel.SequentialTaskExecutor

All Implemented Interfaces:

AutoCloseable, TaskExecutor

class SequentialTaskExecutor
extends Object
implements TaskExecutor

A TaskExecutor for single threaded execution.

Field Summary

Fields

Modifier and Type	Field	Description
private final ExecutorService	executorService
private static final SequentialTaskExecutor	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SequentialTaskExecutor()

Method Summary

Modifier and Type	Method	Description
void	close()
<T> void	forEach(List<? extends T> parameters, Consumer<? super T> task)	Like TaskExecutor.runAll(List) but - instead of a list of tasks - it takes a list of parameters and a function that is called for each of the parameters.
<T,R> List<R>	forEachApply(List<? extends T> parameters, Function<? super T, ? extends R> task)	Like TaskExecutor.forEach(List, Consumer) but collects the results.
ExecutorService	getExecutorService()	Get the underlying ExecutorService.
static TaskExecutor	getInstance()
int	getParallelism()	Get the number of threads that are used for execution.
void	runAll(List<Runnable> tasks)	This method will execute the given list of tasks.
int	suggestNumberOfTasks()	If there is a big task that could be split into sub tasks for parallelization, this method gives you a reasonable number of sub tasks.

Methods inherited from class Object

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

Field Details

INSTANCE

private static final SequentialTaskExecutor INSTANCE

executorService

private final ExecutorService executorService

Constructor Details

SequentialTaskExecutor

private SequentialTaskExecutor()

Method Details

getInstance

public static TaskExecutor getInstance()

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: TaskExecutor

Get the underlying ExecutorService. This is not always a fully functional ExecutorService: Especially the methods ExecutorService.shutdown() and ExecutorService.awaitTermination(long, TimeUnit) must not be used.

Specified by:

getExecutorService in interface TaskExecutor

suggestNumberOfTasks

public int suggestNumberOfTasks()

Description copied from interface: TaskExecutor

If there is a big task that could be split into sub tasks for parallelization, this method gives you a reasonable number of sub tasks.

A single threaded TaskExecutor will return 1. A multi threaded TaskExecutor will usually return 4 times the number of threads.

Specified by:

suggestNumberOfTasks in interface TaskExecutor

getParallelism

public int getParallelism()

Description copied from interface: TaskExecutor

Get the number of threads that are used for execution.

Specified by:

getParallelism in interface TaskExecutor

runAll

public void runAll(List<Runnable> tasks)

Description copied from interface: TaskExecutor

This method will execute the given list of tasks. A single threaded TaskExecutor will execute the tasks one after the other. A multi threaded TaskExecutor will distribute the tasks to the threads. The method blocks until all tasks are completed.

Specified by:

runAll in interface TaskExecutor

forEach

public <T> void forEach(List<? extends T> parameters,
 Consumer<? super T> task)

Description copied from interface: TaskExecutor

Like TaskExecutor.runAll(List) but - instead of a list of tasks - it takes a list of parameters and a function that is called for each of the parameters.

Specified by:

forEach in interface TaskExecutor

forEachApply

public <T,R> List<R> forEachApply(List<? extends T> parameters,
 Function<? super T, ? extends R> task)

Description copied from interface: TaskExecutor

Like TaskExecutor.forEach(List, Consumer) but collects the results.

Specified by:

forEachApply in interface TaskExecutor

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface TaskExecutor