org.junit.platform.launcher.core

Interface LauncherConfig

All Known Implementing Classes:

DefaultLauncherConfig

@API(status=STABLE,
     since="1.7")
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.

Field Summary

Fields

Modifier and Type	Field and Description
static LauncherConfig	DEFAULT The default LauncherConfig which uses automatic registration for test engines, supported listeners, and post-discovery filters.

Method Summary

Modifier and Type	Method and Description
static LauncherConfig.Builder	builder() Create a new LauncherConfig.Builder.
java.util.Collection<LauncherDiscoveryListener>	getAdditionalLauncherDiscoveryListeners() Get the collection of additional launcher discovery listeners that should be added to the Launcher.
java.util.Collection<LauncherSessionListener>	getAdditionalLauncherSessionListeners() Get the collection of additional launcher session listeners that should be added to the Launcher.
java.util.Collection<PostDiscoveryFilter>	getAdditionalPostDiscoveryFilters() Get the collection of additional post discovery filters that should be added to the Launcher.
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	isLauncherDiscoveryListenerAutoRegistrationEnabled() Determine if launcher discovery listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
boolean	isLauncherSessionListenerAutoRegistrationEnabled() Determine if launcher session listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
boolean	isPostDiscoveryFilterAutoRegistrationEnabled() Determine if post discovery filters should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
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.

Field Detail

DEFAULT

static final LauncherConfig DEFAULT

The default LauncherConfig which uses automatic registration for test engines, supported listeners, and post-discovery filters.

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

isLauncherSessionListenerAutoRegistrationEnabled

@API(status=STABLE,
     since="1.10")
boolean isLauncherSessionListenerAutoRegistrationEnabled()

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

Returns:

true if launcher session listeners should be automatically registered

Since:

1.8

isLauncherDiscoveryListenerAutoRegistrationEnabled

@API(status=STABLE,
     since="1.10")
boolean isLauncherDiscoveryListenerAutoRegistrationEnabled()

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

Returns:

true if launcher discovery listeners should be automatically registered

Since:

1.8

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

isPostDiscoveryFilterAutoRegistrationEnabled

@API(status=STABLE,
     since="1.10")
boolean isPostDiscoveryFilterAutoRegistrationEnabled()

Determine if post discovery filters should be discovered at runtime using the ServiceLoader mechanism and automatically registered.

Returns:

true if post discovery filters should be automatically registered

Since:

1.7

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

getAdditionalLauncherSessionListeners

@API(status=STABLE,
     since="1.10")
java.util.Collection<LauncherSessionListener> getAdditionalLauncherSessionListeners()

Get the collection of additional launcher session listeners that should be added to the Launcher.

Returns:

the collection of additional launcher session listeners; never null but potentially empty

Since:

1.8

getAdditionalLauncherDiscoveryListeners

@API(status=STABLE,
     since="1.10")
java.util.Collection<LauncherDiscoveryListener> getAdditionalLauncherDiscoveryListeners()

Get the collection of additional launcher discovery listeners that should be added to the Launcher.

Returns:

the collection of additional launcher discovery listeners; never null but potentially empty

Since:

1.8

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

getAdditionalPostDiscoveryFilters

@API(status=STABLE,
     since="1.10")
java.util.Collection<PostDiscoveryFilter> getAdditionalPostDiscoveryFilters()

Get the collection of additional post discovery filters that should be added to the Launcher.

Returns:

the collection of additional post discovery filters; never null but potentially empty

Since:

1.7

builder

static LauncherConfig.Builder builder()

Create a new LauncherConfig.Builder.

Returns:

a new builder; never null