nonapi.io.github.classgraph.concurrency

Class WorkQueue<T>

java.lang.Object

nonapi.io.github.classgraph.concurrency.WorkQueue<T>

Type Parameters:

T - The work unit type.

All Implemented Interfaces:

java.lang.AutoCloseable

public class WorkQueue<T>
extends java.lang.Object
implements java.lang.AutoCloseable

A parallel work queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkQueue.WorkUnitProcessor<T> A work unit processor.

Method Summary

Modifier and Type	Method and Description
void	addWorkUnit(T workUnit) Add a unit of work.
void	addWorkUnits(java.util.Collection<T> workUnits) Add multiple units of work.
void	close() Completion barrier for work queue.
static <U> void	runWorkQueue(java.util.Collection<U> elements, java.util.concurrent.ExecutorService executorService, InterruptionChecker interruptionChecker, int numParallelTasks, LogNode log, WorkQueue.WorkUnitProcessor<U> workUnitProcessor) Start a work queue on the elements in the provided collection, blocking until all work units have been completed.

Methods inherited from class java.lang.Object

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

Method Detail

runWorkQueue

public static <U> void runWorkQueue(java.util.Collection<U> elements,
                                    java.util.concurrent.ExecutorService executorService,
                                    InterruptionChecker interruptionChecker,
                                    int numParallelTasks,
                                    LogNode log,
                                    WorkQueue.WorkUnitProcessor<U> workUnitProcessor)
                             throws java.lang.InterruptedException,
                                    java.util.concurrent.ExecutionException

Start a work queue on the elements in the provided collection, blocking until all work units have been completed.

Type Parameters:

U - The type of the work queue units.

Parameters:

elements - The work queue units to process.

executorService - The ExecutorService.

interruptionChecker - the interruption checker

numParallelTasks - The number of parallel tasks.

log - The log.

workUnitProcessor - The WorkQueue.WorkUnitProcessor.

Throws:

java.lang.InterruptedException - If the work was interrupted.

java.util.concurrent.ExecutionException - If a worker throws an uncaught exception.

addWorkUnit

public void addWorkUnit(T workUnit)

Add a unit of work. May be called by workers to add more work units to the tail of the queue.

Parameters:

workUnit - the work unit

Throws:

java.lang.NullPointerException - if the work unit is null.

addWorkUnits

public void addWorkUnits(java.util.Collection<T> workUnits)

Add multiple units of work. May be called by workers to add more work units to the tail of the queue.

Parameters:

workUnits - The work units to add to the tail of the queue.

Throws:

java.lang.NullPointerException - if any of the work units are null.

close

public void close()
           throws java.util.concurrent.ExecutionException

Completion barrier for work queue. This should be called after runWorkLoop() exits on the main thread (e.g. using try-with-resources).

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.util.concurrent.ExecutionException - If a worker threw an uncaught exception.