Modifier and Type	Class and Description
public static class	LauncherConfig.Builder Builder API for `LauncherConfig`.

Modifier and Type	Field and Description
public static final 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
public static LauncherConfig.Builder	Returns: a new builder; never `null` builder() Create a new `LauncherConfig.Builder`.
public Collection<LauncherDiscoveryListener>	Returns: the collection of additional launcher discovery listeners; never `null` but potentially empty getAdditionalLauncherDiscoveryListeners() Get the collection of additional launcher discovery listeners that should be added to the `Launcher`.
public Collection<LauncherSessionListener>	Returns: the collection of additional launcher session listeners; never `null` but potentially empty getAdditionalLauncherSessionListeners() Get the collection of additional launcher session listeners that should be added to the `Launcher`.
public Collection<PostDiscoveryFilter>	Returns: the collection of additional post discovery filters; never `null` but potentially empty getAdditionalPostDiscoveryFilters() Get the collection of additional post discovery filters that should be added to the `Launcher`.
public Collection<TestEngine>	Returns: the collection of additional test engines; never `null` but potentially empty getAdditionalTestEngines() Get the collection of additional test engines that should be added to the `Launcher`.
public Collection<TestExecutionListener>	Returns: the collection of additional test execution listeners; never `null` but potentially empty getAdditionalTestExecutionListeners() Get the collection of additional test execution listeners that should be added to the `Launcher`.
public boolean	Returns: `true` if launcher discovery listeners should be automatically registered isLauncherDiscoveryListenerAutoRegistrationEnabled() Determine if launcher discovery listeners should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered.
public boolean	Returns: `true` if launcher session listeners should be automatically registered isLauncherSessionListenerAutoRegistrationEnabled() Determine if launcher session listeners should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered.
public boolean	Returns: `true` if post discovery filters should be automatically registered isPostDiscoveryFilterAutoRegistrationEnabled() Determine if post discovery filters should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered.
public boolean	Returns: `true` if test engines should be automatically registered isTestEngineAutoRegistrationEnabled() Determine if test engines should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered.
public boolean	Returns: `true` if test execution listeners should be automatically registered isTestExecutionListenerAutoRegistrationEnabled() Determine if test execution listeners should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered.

Field Detail

DEFAULT	back to summary
public static final LauncherConfig DEFAULT The default `LauncherConfig` which uses automatic registration for test engines, supported listeners, and post-discovery filters.

Method Detail

builder back to summary

builder	back to summary
public static LauncherConfig.Builder builder() Create a new `LauncherConfig.Builder`. Returns:LauncherConfig.Builder a new builder; never `null`

public static LauncherConfig.Builder builder()

Create a new LauncherConfig.Builder.

Returns:LauncherConfig.Builder: a new builder; never null

getAdditionalLauncherDiscoveryListeners back to summary

getAdditionalLauncherDiscoveryListeners	back to summary
public Collection<LauncherDiscoveryListener> getAdditionalLauncherDiscoveryListeners() Get the collection of additional launcher discovery listeners that should be added to the `Launcher`. Returns:Collection<LauncherDiscoveryListener> the collection of additional launcher discovery listeners; never `null` but potentially empty Annotations @API status:STABLE since:1.10 Since 1.8

public Collection<LauncherDiscoveryListener> getAdditionalLauncherDiscoveryListeners()

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

Returns:Collection<LauncherDiscoveryListener>

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

Annotations

@API
status:STABLE
since:1.10

Since

1.8

getAdditionalLauncherSessionListeners back to summary

getAdditionalLauncherSessionListeners	back to summary
public Collection<LauncherSessionListener> getAdditionalLauncherSessionListeners() Get the collection of additional launcher session listeners that should be added to the `Launcher`. Returns:Collection<LauncherSessionListener> the collection of additional launcher session listeners; never `null` but potentially empty Annotations @API status:STABLE since:1.10 Since 1.8

public Collection<LauncherSessionListener> getAdditionalLauncherSessionListeners()

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

Returns:Collection<LauncherSessionListener>

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

Annotations

@API
status:STABLE
since:1.10

Since

1.8

getAdditionalPostDiscoveryFilters back to summary

getAdditionalPostDiscoveryFilters	back to summary
public Collection<PostDiscoveryFilter> getAdditionalPostDiscoveryFilters() Get the collection of additional post discovery filters that should be added to the `Launcher`. Returns:Collection<PostDiscoveryFilter> the collection of additional post discovery filters; never `null` but potentially empty Annotations @API status:STABLE since:1.10 Since 1.7

public Collection<PostDiscoveryFilter> getAdditionalPostDiscoveryFilters()

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

Returns:Collection<PostDiscoveryFilter>

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

Annotations

@API
status:STABLE
since:1.10

Since

1.7

getAdditionalTestEngines back to summary

getAdditionalTestEngines	back to summary
public Collection<TestEngine> getAdditionalTestEngines() Get the collection of additional test engines that should be added to the `Launcher`. Returns:Collection<TestEngine> the collection of additional test engines; never `null` but potentially empty

public Collection<TestEngine> getAdditionalTestEngines()

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

Returns:Collection<TestEngine>: the collection of additional test engines; never null but potentially empty

getAdditionalTestExecutionListeners back to summary

getAdditionalTestExecutionListeners	back to summary
public Collection<TestExecutionListener> getAdditionalTestExecutionListeners() Get the collection of additional test execution listeners that should be added to the `Launcher`. Returns:Collection<TestExecutionListener> the collection of additional test execution listeners; never `null` but potentially empty

public Collection<TestExecutionListener> getAdditionalTestExecutionListeners()

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

Returns:Collection<TestExecutionListener>: the collection of additional test execution listeners; never null but potentially empty

isLauncherDiscoveryListenerAutoRegistrationEnabled back to summary

isLauncherDiscoveryListenerAutoRegistrationEnabled	back to summary
public boolean isLauncherDiscoveryListenerAutoRegistrationEnabled() Determine if launcher discovery listeners should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered. Returns:boolean `true` if launcher discovery listeners should be automatically registered Annotations @API status:STABLE since:1.10 Since 1.8

public boolean isLauncherDiscoveryListenerAutoRegistrationEnabled()

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

Returns:boolean

true if launcher discovery listeners should be automatically registered

Annotations

@API
status:STABLE
since:1.10

Since

1.8

isLauncherSessionListenerAutoRegistrationEnabled back to summary

isLauncherSessionListenerAutoRegistrationEnabled	back to summary
public boolean isLauncherSessionListenerAutoRegistrationEnabled() Determine if launcher session listeners should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered. Returns:boolean `true` if launcher session listeners should be automatically registered Annotations @API status:STABLE since:1.10 Since 1.8

public boolean isLauncherSessionListenerAutoRegistrationEnabled()

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

Returns:boolean

true if launcher session listeners should be automatically registered

Annotations

@API
status:STABLE
since:1.10

Since

1.8

isPostDiscoveryFilterAutoRegistrationEnabled back to summary

isPostDiscoveryFilterAutoRegistrationEnabled	back to summary
public boolean isPostDiscoveryFilterAutoRegistrationEnabled() Determine if post discovery filters should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered. Returns:boolean `true` if post discovery filters should be automatically registered Annotations @API status:STABLE since:1.10 Since 1.7

public boolean isPostDiscoveryFilterAutoRegistrationEnabled()

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

Returns:boolean

true if post discovery filters should be automatically registered

Annotations

@API
status:STABLE
since:1.10

Since

1.7

isTestEngineAutoRegistrationEnabled back to summary

isTestEngineAutoRegistrationEnabled	back to summary
public boolean isTestEngineAutoRegistrationEnabled() Determine if test engines should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered. Returns:boolean `true` if test engines should be automatically registered

public boolean isTestEngineAutoRegistrationEnabled()

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

Returns:boolean: true if test engines should be automatically registered

isTestExecutionListenerAutoRegistrationEnabled back to summary

isTestExecutionListenerAutoRegistrationEnabled	back to summary
public boolean isTestExecutionListenerAutoRegistrationEnabled() Determine if test execution listeners should be discovered at runtime using the `ServiceLoader` mechanism and automatically registered. Returns:boolean `true` if test execution listeners should be automatically registered

public boolean isTestExecutionListenerAutoRegistrationEnabled()

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

Returns:boolean: true if test execution listeners should be automatically registered

org.junit.platform.launcher.core back to summary

public Class LauncherConfig.Builder

Class Inheritance

extends Object

java.lang.Object
org.junit.platform.launcher.core.LauncherConfig.Builder

Builder API for LauncherConfig.

Field Summary

Modifier and Type	Field and Description
private final Collection<LauncherDiscoveryListener>	discoveryListeners
private boolean	engineAutoRegistrationEnabled
private final Collection<TestEngine>	engines
private final Collection<TestExecutionListener>	executionListeners
private boolean	launcherDiscoveryListenerAutoRegistrationEnabled
private boolean	launcherSessionListenerAutoRegistrationEnabled
private boolean	postDiscoveryFilterAutoRegistrationEnabled
private final Collection<PostDiscoveryFilter>	postDiscoveryFilters
private final Collection<LauncherSessionListener>	sessionListeners
private boolean	testExecutionListenerAutoRegistrationEnabled

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public LauncherConfig.Builder	Returns: this builder for method chaining addLauncherDiscoveryListeners(LauncherDiscoveryListener... additional launcher discovery listeners to register; never `null` or containing `null` listeners) Add all of the supplied launcher discovery listeners to the configuration.
public LauncherConfig.Builder	Returns: this builder for method chaining addLauncherSessionListeners(LauncherSessionListener... additional launcher session listeners to register; never `null` or containing `null` listeners) Add all of the supplied launcher session listeners to the configuration.
public LauncherConfig.Builder	Returns: this builder for method chaining addPostDiscoveryFilters(PostDiscoveryFilter... additional post discovery filters to register; never `null` or containing `null` filters) Add all of the supplied `filters` to the configuration.
public LauncherConfig.Builder	Returns: this builder for method chaining addTestEngines(TestEngine... additional test engines to register; never `null` or containing `null` engines) Add all of the supplied test engines to the configuration.
public LauncherConfig.Builder	Returns: this builder for method chaining addTestExecutionListeners(TestExecutionListener... additional test execution listeners to register; never `null` or containing `null` listeners) Add all of the supplied test execution listeners to the configuration.
public LauncherConfig	build() Build the `LauncherConfig` that has been configured via this builder.
public LauncherConfig.Builder	Returns: this builder for method chaining enableLauncherDiscoveryListenerAutoRegistration(boolean `true` if launcher discovery listeners should be automatically registered enabled) Configure the auto-registration flag for launcher discovery listeners.
public LauncherConfig.Builder	Returns: this builder for method chaining enableLauncherSessionListenerAutoRegistration(boolean `true` if launcher session listeners should be automatically registered enabled) Configure the auto-registration flag for launcher session listeners.
public LauncherConfig.Builder	Returns: this builder for method chaining enablePostDiscoveryFilterAutoRegistration(boolean `true` if post discovery filters should be automatically registered enabled) Configure the auto-registration flag for post discovery filters.
public LauncherConfig.Builder	Returns: this builder for method chaining enableTestEngineAutoRegistration(boolean `true` if test engines should be automatically registered enabled) Configure the auto-registration flag for test engines.
public LauncherConfig.Builder	Returns: this builder for method chaining enableTestExecutionListenerAutoRegistration(boolean `true` if test execution listeners should be automatically registered enabled) Configure the auto-registration flag for test execution listeners.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

discoveryListeners	back to summary
private final Collection<LauncherDiscoveryListener> discoveryListeners

engineAutoRegistrationEnabled	back to summary
private boolean engineAutoRegistrationEnabled

engines	back to summary
private final Collection<TestEngine> engines

executionListeners	back to summary
private final Collection<TestExecutionListener> executionListeners

launcherDiscoveryListenerAutoRegistrationEnabled	back to summary
private boolean launcherDiscoveryListenerAutoRegistrationEnabled

launcherSessionListenerAutoRegistrationEnabled	back to summary
private boolean launcherSessionListenerAutoRegistrationEnabled

postDiscoveryFilterAutoRegistrationEnabled	back to summary
private boolean postDiscoveryFilterAutoRegistrationEnabled

postDiscoveryFilters	back to summary
private final Collection<PostDiscoveryFilter> postDiscoveryFilters

sessionListeners	back to summary
private final Collection<LauncherSessionListener> sessionListeners

testExecutionListenerAutoRegistrationEnabled	back to summary
private boolean testExecutionListenerAutoRegistrationEnabled

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

addLauncherDiscoveryListeners back to summary

addLauncherDiscoveryListeners	back to summary
public LauncherConfig.Builder addLauncherDiscoveryListeners(LauncherDiscoveryListener... listeners) Add all of the supplied launcher discovery listeners to the configuration. Parameters listeners:LauncherDiscoveryListener[] additional launcher discovery listeners to register; never `null` or containing `null` Returns:LauncherConfig.Builder this builder for method chaining

public LauncherConfig.Builder addLauncherDiscoveryListeners(LauncherDiscoveryListener... listeners)

Add all of the supplied launcher discovery listeners to the configuration.

Parameters

listeners:LauncherDiscoveryListener[]: additional launcher discovery listeners to register; never null or containing null

Returns:LauncherConfig.Builder

this builder for method chaining

addLauncherSessionListeners back to summary

addLauncherSessionListeners	back to summary
public LauncherConfig.Builder addLauncherSessionListeners(LauncherSessionListener... listeners) Add all of the supplied launcher session listeners to the configuration. Parameters listeners:LauncherSessionListener[] additional launcher session listeners to register; never `null` or containing `null` Returns:LauncherConfig.Builder this builder for method chaining

public LauncherConfig.Builder addLauncherSessionListeners(LauncherSessionListener... listeners)

Add all of the supplied launcher session listeners to the configuration.

Parameters

listeners:LauncherSessionListener[]: additional launcher session listeners to register; never null or containing null

Returns:LauncherConfig.Builder

this builder for method chaining

addPostDiscoveryFilters back to summary

addPostDiscoveryFilters	back to summary
public LauncherConfig.Builder addPostDiscoveryFilters(PostDiscoveryFilter... filters) Add all of the supplied `filters` to the configuration. Parameters filters:PostDiscoveryFilter[] additional post discovery filters to register; never `null` or containing `null` Returns:LauncherConfig.Builder this builder for method chaining Annotations @API status:STABLE since:1.10 Since 1.7

public LauncherConfig.Builder addPostDiscoveryFilters(PostDiscoveryFilter... filters)

Add all of the supplied filters to the configuration.

Parameters

filters:PostDiscoveryFilter[]: additional post discovery filters to register; never null or containing null

Returns:LauncherConfig.Builder

this builder for method chaining

Annotations

@API
status:STABLE
since:1.10

Since

1.7

addTestEngines back to summary

addTestEngines	back to summary
public LauncherConfig.Builder addTestEngines(TestEngine... engines) Add all of the supplied test engines to the configuration. Parameters engines:TestEngine[] additional test engines to register; never `null` or containing `null` Returns:LauncherConfig.Builder this builder for method chaining

public LauncherConfig.Builder addTestEngines(TestEngine... engines)

Add all of the supplied test engines to the configuration.

Parameters

engines:TestEngine[]: additional test engines to register; never null or containing null

Returns:LauncherConfig.Builder

this builder for method chaining

addTestExecutionListeners back to summary

addTestExecutionListeners	back to summary
public LauncherConfig.Builder addTestExecutionListeners(TestExecutionListener... listeners) Add all of the supplied test execution listeners to the configuration. Parameters listeners:TestExecutionListener[] additional test execution listeners to register; never `null` or containing `null` Returns:LauncherConfig.Builder this builder for method chaining

public LauncherConfig.Builder addTestExecutionListeners(TestExecutionListener... listeners)

Add all of the supplied test execution listeners to the configuration.

Parameters

listeners:TestExecutionListener[]: additional test execution listeners to register; never null or containing null

Returns:LauncherConfig.Builder

this builder for method chaining

build	back to summary
public LauncherConfig build() Build the `LauncherConfig` that has been configured via this builder.

enableLauncherDiscoveryListenerAutoRegistration back to summary

enableLauncherDiscoveryListenerAutoRegistration	back to summary
public LauncherConfig.Builder enableLauncherDiscoveryListenerAutoRegistration(boolean enabled) Configure the auto-registration flag for launcher discovery listeners. Defaults to `true`. Parameters enabled:boolean `true` if launcher discovery listeners should be automatically registered Returns:LauncherConfig.Builder this builder for method chaining Annotations @API status:STABLE since:1.10 Since 1.8

public LauncherConfig.Builder enableLauncherDiscoveryListenerAutoRegistration(boolean enabled)

Configure the auto-registration flag for launcher discovery listeners.

Defaults to true.

Parameters

enabled:boolean: true if launcher discovery listeners should be automatically registered

Returns:LauncherConfig.Builder

this builder for method chaining

Annotations

@API
status:STABLE
since:1.10

Since

1.8

enableLauncherSessionListenerAutoRegistration back to summary

enableLauncherSessionListenerAutoRegistration	back to summary
public LauncherConfig.Builder enableLauncherSessionListenerAutoRegistration(boolean enabled) Configure the auto-registration flag for launcher session listeners. Defaults to `true`. Parameters enabled:boolean `true` if launcher session listeners should be automatically registered Returns:LauncherConfig.Builder this builder for method chaining Annotations @API status:STABLE since:1.10 Since 1.8

public LauncherConfig.Builder enableLauncherSessionListenerAutoRegistration(boolean enabled)

Configure the auto-registration flag for launcher session listeners.

Defaults to true.

Parameters

enabled:boolean: true if launcher session listeners should be automatically registered

Returns:LauncherConfig.Builder

this builder for method chaining

Annotations

@API
status:STABLE
since:1.10

Since

1.8

enablePostDiscoveryFilterAutoRegistration back to summary

enablePostDiscoveryFilterAutoRegistration	back to summary
public LauncherConfig.Builder enablePostDiscoveryFilterAutoRegistration(boolean enabled) Configure the auto-registration flag for post discovery filters. Defaults to `true`. Parameters enabled:boolean `true` if post discovery filters should be automatically registered Returns:LauncherConfig.Builder this builder for method chaining Annotations @API status:STABLE since:1.10 Since 1.7

public LauncherConfig.Builder enablePostDiscoveryFilterAutoRegistration(boolean enabled)

Configure the auto-registration flag for post discovery filters.

Defaults to true.

Parameters

enabled:boolean: true if post discovery filters should be automatically registered

Returns:LauncherConfig.Builder

this builder for method chaining

Annotations

@API
status:STABLE
since:1.10

Since

1.7

enableTestEngineAutoRegistration back to summary

enableTestEngineAutoRegistration	back to summary
public LauncherConfig.Builder enableTestEngineAutoRegistration(boolean enabled) Configure the auto-registration flag for test engines. Defaults to `true`. Parameters enabled:boolean `true` if test engines should be automatically registered Returns:LauncherConfig.Builder this builder for method chaining

public LauncherConfig.Builder enableTestEngineAutoRegistration(boolean enabled)

Configure the auto-registration flag for test engines.

Defaults to true.

Parameters

enabled:boolean: true if test engines should be automatically registered

Returns:LauncherConfig.Builder

this builder for method chaining

enableTestExecutionListenerAutoRegistration back to summary

enableTestExecutionListenerAutoRegistration	back to summary
public LauncherConfig.Builder enableTestExecutionListenerAutoRegistration(boolean enabled) Configure the auto-registration flag for test execution listeners. Defaults to `true`. Parameters enabled:boolean `true` if test execution listeners should be automatically registered Returns:LauncherConfig.Builder this builder for method chaining

public LauncherConfig.Builder enableTestExecutionListenerAutoRegistration(boolean enabled)

Configure the auto-registration flag for test execution listeners.

Defaults to true.

Parameters

enabled:boolean: true if test execution listeners should be automatically registered

Returns:LauncherConfig.Builder

this builder for method chaining

public Interface LauncherConfig

Example

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class LauncherConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail