Package org.apache.maven.internal.impl.util

Class PhasingExecutor

java.lang.Object

org.apache.maven.internal.impl.util.PhasingExecutor

All Implemented Interfaces:

AutoCloseable, Executor

public class PhasingExecutor
extends Object
implements Executor, AutoCloseable

The phasing executor allows executing tasks in parallel and waiting for all tasks to be executed before fully closing the executor. Tasks can be submitted even after the close method has been called, allowing for use with try-with-resources. The phase() method can be used to submit tasks and wait for them to be executed without closing the executor.

Example usage:

 try (PhasingExecutor executor = createExecutor()) {
     try (var phase = executor.phase()) {
         executor.execute(() -> { /* task 1 */ });
         executor.execute(() -> { /* task 2 */ });
         More tasks...
     } This will wait for all tasks in this phase to complete

     You can have multiple phases
     try (var anotherPhase = executor.phase()) {
         executor.execute(() -> { /* another task */ });
     }
 } The executor will wait for all tasks to complete before shutting down
 

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicInteger	activeTaskCount
private final AtomicInteger	completedTaskCount
private final ExecutorService	executor
private final int	id
private static final AtomicInteger	ID
private final AtomicBoolean	inPhase
private final ReentrantLock	lock
private static final org.slf4j.Logger	LOGGER
private final AtomicBoolean	shutdownInitiated
private final Condition	taskCompletionCondition

Constructor Summary

Constructors

Constructor	Description
PhasingExecutor(ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
void	close()
void	execute(Runnable command)
private void	log(String message)
private void	log(String message, Object o1)
private void	log(String message, Object o1, Object o2)
AutoCloseable	phase()

Methods inherited from class java.lang.Object

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

Field Details

ID

private static final AtomicInteger ID

LOGGER

private static final org.slf4j.Logger LOGGER

executor

private final ExecutorService executor

shutdownInitiated

private final AtomicBoolean shutdownInitiated

inPhase

private final AtomicBoolean inPhase

activeTaskCount

private final AtomicInteger activeTaskCount

completedTaskCount

private final AtomicInteger completedTaskCount

id

private final int id

lock

private final ReentrantLock lock

taskCompletionCondition

private final Condition taskCompletionCondition

Constructor Details

PhasingExecutor

public PhasingExecutor(ExecutorService executor)

Method Details

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

phase

public AutoCloseable phase()

close

public void close()

Specified by:

close in interface AutoCloseable

log

private void log(String message)

log

private void log(String message,
 Object o1)

log

private void log(String message,
 Object o1,
 Object o2)