org.junit.platform.launcher.core

Interface LauncherConfig

All Known Implementing Classes:

DefaultLauncherConfig

@API(status=EXPERIMENTAL,
     since="1.3")
public interface LauncherConfig

LauncherConfig defines the configuration API for creating Launcher instances via the LauncherFactory.

Example

 LauncherConfig launcherConfig = LauncherConfig.builder()
   .enableTestEngineAutoRegistration(false)
   .enableTestExecutionListenerAutoRegistration(false)
   .addTestEngines(new CustomTestEngine())
   .addTestExecutionListeners(new CustomTestExecutionListener())
   .build();

 Launcher launcher = LauncherFactory.create(launcherConfig);
 LauncherDiscoveryRequest discoveryRequest = ...
 launcher.execute(discoveryRequest);
 

Since:

1.3

See Also:

builder(), Launcher, LauncherFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LauncherConfig.Builder Builder API for LauncherConfig.

Method Summary

Modifier and Type	Method and Description
static LauncherConfig.Builder	builder() Create a new LauncherConfig.Builder.
java.util.Collection<TestEngine>	getAdditionalTestEngines() Get the collection of additional test engines that should be added to the Launcher.
java.util.Collection<TestExecutionListener>	getAdditionalTestExecutionListeners() Get the collection of additional test execution listeners that should be added to the Launcher.
boolean	isTestEngineAutoRegistrationEnabled() Determine if test engines should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
boolean	isTestExecutionListenerAutoRegistrationEnabled() Determine if test execution listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.

Method Detail

isTestEngineAutoRegistrationEnabled

boolean isTestEngineAutoRegistrationEnabled()

Determine if test engines should be discovered at runtime using the ServiceLoader mechanism and automatically registered.

Returns:

true if test engines should be automatically registered

isTestExecutionListenerAutoRegistrationEnabled

boolean isTestExecutionListenerAutoRegistrationEnabled()

Determine if test execution listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.

Returns:

true if test execution listeners should be automatically registered

getAdditionalTestEngines

java.util.Collection<TestEngine> getAdditionalTestEngines()

Get the collection of additional test engines that should be added to the Launcher.

Returns:

the collection of additional test engines; never null but potentially empty

getAdditionalTestExecutionListeners

java.util.Collection<TestExecutionListener> getAdditionalTestExecutionListeners()

Get the collection of additional test execution listeners that should be added to the Launcher.

Returns:

the collection of additional test execution listeners; never null but potentially empty

builder

static LauncherConfig.Builder builder()

Create a new LauncherConfig.Builder.

Returns:

a new builder; never null