Class ForkJoinPoolHierarchicalTestExecutorService

java.lang.Object

org.junit.platform.engine.support.hierarchical.ForkJoinPoolHierarchicalTestExecutorService

All Implemented Interfaces:

AutoCloseable, HierarchicalTestExecutorService

@API(status=MAINTAINED,
     since="1.10")
public class ForkJoinPoolHierarchicalTestExecutorService
extends Object
implements HierarchicalTestExecutorService

A ForkJoinPool-based executor service that executes test tasks with the configured parallelism.

Since:

1.3

See Also:

• ParallelHierarchicalTestExecutorServiceFactory
• ParallelHierarchicalTestExecutorServiceFactory.ParallelExecutorServiceType.FORK_JOIN_POOL
• DefaultParallelExecutionConfigurationStrategy
• ForkJoinPool

Nested Class Summary

Nested classes/interfaces inherited from interface HierarchicalTestExecutorService

HierarchicalTestExecutorService.TestTask

Constructor Summary

Constructors

Constructor	Description
ForkJoinPoolHierarchicalTestExecutorService(ConfigurationParameters configurationParameters)	Deprecated. Please use ParallelHierarchicalTestExecutorServiceFactory.create(ConfigurationParameters) with configuration parameter "executor-service" set to FORK_JOIN_POOL instead.
ForkJoinPoolHierarchicalTestExecutorService(ParallelExecutionConfiguration configuration)	Deprecated. Please use ParallelHierarchicalTestExecutorServiceFactory.create(ParallelExecutorServiceType, ParallelExecutionConfiguration) with ParallelExecutorServiceType.FORK_JOIN_POOL instead.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this service and let it perform any required cleanup work.
void	invokeAll(List<? extends HierarchicalTestExecutorService.TestTask> tasks)	Invoke all supplied test tasks and block until their execution has finished.
Future<@Nullable Void>	submit(HierarchicalTestExecutorService.TestTask testTask)	Submit the supplied test task to be executed by this service.

Methods inherited from class Object

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

Constructor Details

ForkJoinPoolHierarchicalTestExecutorService

@API(status=DEPRECATED,
     since="6.1")
@Deprecated(since="6.1")
public ForkJoinPoolHierarchicalTestExecutorService(ConfigurationParameters configurationParameters)

Deprecated.

Please use ParallelHierarchicalTestExecutorServiceFactory.create(ConfigurationParameters) with configuration parameter "executor-service" set to FORK_JOIN_POOL instead.

Create a new ForkJoinPoolHierarchicalTestExecutorService based on the supplied ConfigurationParameters.

See Also:

• DefaultParallelExecutionConfigurationStrategy

ForkJoinPoolHierarchicalTestExecutorService

@API(status=DEPRECATED,
     since="6.1")
@Deprecated(since="6.1")
public ForkJoinPoolHierarchicalTestExecutorService(ParallelExecutionConfiguration configuration)

Deprecated.

Please use ParallelHierarchicalTestExecutorServiceFactory.create(ParallelExecutorServiceType, ParallelExecutionConfiguration) with ParallelExecutorServiceType.FORK_JOIN_POOL instead.

Create a new ForkJoinPoolHierarchicalTestExecutorService based on the supplied ParallelExecutionConfiguration.

Since:

1.7

Method Details

submit

public Future<@Nullable Void> submit(HierarchicalTestExecutorService.TestTask testTask)

Description copied from interface: HierarchicalTestExecutorService

Submit the supplied test task to be executed by this service.

Implementations may execute the task asynchronously as long as its execution mode is concurrent.

Implementations must generally acquire and release the task's resource lock before and after its execution unless they execute all tests in the same thread which upholds the same guarantees.

Specified by:

submit in interface HierarchicalTestExecutorService

Parameters:

testTask - the test task to be executed

Returns:

a future that the caller can use to wait for the task's execution to be finished

See Also:

• HierarchicalTestExecutorService.invokeAll(List)

invokeAll

public void invokeAll(List<? extends HierarchicalTestExecutorService.TestTask> tasks)

Description copied from interface: HierarchicalTestExecutorService

Invoke all supplied test tasks and block until their execution has finished.

Implementations may execute one or multiple of the supplied tasks in parallel as long as their execution mode is concurrent.

Implementations must generally acquire and release each task's resource lock before and after its execution unless they execute all tests in the same thread which upholds the same guarantees.

Specified by:

invokeAll in interface HierarchicalTestExecutorService

Parameters:

tasks - the test tasks to be executed

See Also:

• HierarchicalTestExecutorService.submit(TestTask)

close

public void close()

Description copied from interface: HierarchicalTestExecutorService

Close this service and let it perform any required cleanup work.

For example, thread-based implementations should usually close their thread pools in this method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface HierarchicalTestExecutorService