JUnit 6.0.1 · org.junit.platform.suite.engine.SuiteLauncherDiscoveryRequestBuilder

Modifier and Type	Field and Description
private final LauncherDiscoveryRequestBuilder	delegate
private boolean	enableParentConfigurationParameters
private boolean	filterStandardClassNamePatterns
private boolean	includeClassNamePatternsUsed
private @Nullable ConfigurationParameters	parentConfigurationParameters
private final Set<String>	selectedClassNames

Access	Constructor and Description
private	SuiteLauncherDiscoveryRequestBuilder()

Method Summary

Modifier and Type	Method and Description
private void	addClassAndMethodSelectors(Class<?> suiteClass)
private void	addExcludeFilters(Class<?> suiteClass)
private void	addIncludeFilters(Class<?> suiteClass)
private void	addOtherSelectors(Class<?> suiteClass)
pack-priv SuiteLauncherDiscoveryRequestBuilder	Returns: this builder for method chaining applyConfigurationParametersFromSuite(Class<?> the class to apply the configuration annotations from; never `null` suiteClass) Apply a suite's annotation-based configuration to this builder.
pack-priv SuiteLauncherDiscoveryRequestBuilder	Returns: this builder for method chaining applySelectorsAndFiltersFromSuite(Class<?> the class to apply the discovery selectors and filter annotations from; never `null` suiteClass) Apply a suite's annotation-based discovery selectors and filters to this builder.
pack-priv LauncherDiscoveryRequest	build() Build the `LauncherDiscoveryRequest` that has been configured via this builder.
pack-priv SuiteLauncherDiscoveryRequestBuilder	Returns: this builder for method chaining configurationParameter(String the configuration parameter key under which to store the value; never `null` or blank key, String the value to store value) Add the supplied configuration parameter to the request.
pack-priv void	configurationParametersResource(String resourceFile)
private ClassNameFilter	createIncludeClassNameFilter(String... patterns)
pack-priv SuiteLauncherDiscoveryRequestBuilder	Returns: this builder for method chaining disableImplicitConfigurationParameters() Configure whether implicit configuration parameters should be considered.
private void	filters(Filter<?>... the `Filter`s to add; never `null` filters) Add all supplied `filters` to the request.
pack-priv SuiteLauncherDiscoveryRequestBuilder	Returns: this builder for method chaining filterStandardClassNamePatterns() Specify whether to filter standard class name patterns.
private static <A extends Annotation, V> Optional<V[]>	findAnnotationValues(AnnotatedElement element, Class<A> annotationType, Function<A, V[]> valueExtractor)
pack-priv void	listener(LauncherDiscoveryListener listener)
pack-priv SuiteLauncherDiscoveryRequestBuilder	outputDirectoryCreator(OutputDirectoryCreator outputDirectoryCreator)
pack-priv SuiteLauncherDiscoveryRequestBuilder	Returns: this builder for method chaining parentConfigurationParameters(ConfigurationParameters the parent instance to use for looking up configuration parameters that have not been explicitly configured; never `null` parentConfigurationParameters) Set the parent configuration parameters to use for the request.
private static String	prefixErrorMessageForInvalidSelectMethodUsage(Class<?> suiteClass, String detailMessage)
pack-priv static SuiteLauncherDiscoveryRequestBuilder	Returns: a new builder request() Create a new `SuiteLauncherDiscoveryRequestBuilder`.
private List<ClassSelector>	selectClasses(Class<?> suiteClass, SelectClasses annotation)
private MethodSelector	selectMethod(Class<?> suiteClass, SelectMethod annotation)
pack-priv void	selectors(DiscoverySelector... the `DiscoverySelectors` to add; never `null` selectors) Add all supplied `selectors` to the request.
private void	selectors(List<? extends DiscoverySelector> the `DiscoverySelectors` to add; never `null` selectors) Add all supplied `selectors` to the request.
private static Optional<String[]>	stripped(String[] patterns)
private static Stream<ClassSelector>	toClassSelectors(Class<?> suiteClass, SelectClasses annotation)
private MethodSelector	toMethodSelector(Class<?> suiteClass, SelectMethod annotation)
private static MethodSelector	toMethodSelector(Class<?> suiteClass, @Nullable Class<?> type, @Nullable String typeName, @Nullable Class<?>[] parameterTypes, String methodName, String parameterTypeNames)
private static MethodSelector	toMethodSelectorFromFQMN(Class<?> suiteClass, SelectMethod annotation)

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

delegate	back to summary
private final LauncherDiscoveryRequestBuilder delegate

enableParentConfigurationParameters	back to summary
private boolean enableParentConfigurationParameters

filterStandardClassNamePatterns	back to summary
private boolean filterStandardClassNamePatterns

includeClassNamePatternsUsed	back to summary
private boolean includeClassNamePatternsUsed

parentConfigurationParameters	back to summary
private @Nullable ConfigurationParameters parentConfigurationParameters

selectedClassNames	back to summary
private final Set<String> selectedClassNames

SuiteLauncherDiscoveryRequestBuilder	back to summary
private SuiteLauncherDiscoveryRequestBuilder()

Method Detail

addClassAndMethodSelectors	back to summary
private void addClassAndMethodSelectors(Class<?> suiteClass)

addExcludeFilters	back to summary
private void addExcludeFilters(Class<?> suiteClass)

addIncludeFilters	back to summary
private void addIncludeFilters(Class<?> suiteClass)

addOtherSelectors	back to summary
private void addOtherSelectors(Class<?> suiteClass)

applyConfigurationParametersFromSuite back to summary

applyConfigurationParametersFromSuite	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder applyConfigurationParametersFromSuite(Class<?> suiteClass) Apply a suite's annotation-based configuration to this builder. This will apply the configuration from the following annotations. `ConfigurationParameter` `DisableParentConfigurationParameters` Parameters suiteClass:Class<?> the class to apply the configuration annotations from; never `null` Returns:SuiteLauncherDiscoveryRequestBuilder this builder for method chaining Since 1.11 See Also `org.junit.platform.suite.api.Suite`

pack-priv SuiteLauncherDiscoveryRequestBuilder applyConfigurationParametersFromSuite(Class<?> suiteClass)

Apply a suite's annotation-based configuration to this builder.

This will apply the configuration from the following annotations.

Parameters

suiteClass:Class<?>: the class to apply the configuration annotations from; never null

Returns:SuiteLauncherDiscoveryRequestBuilder

this builder for method chaining

Since

1.11

See Also

org.junit.platform.suite.api.Suite

applySelectorsAndFiltersFromSuite back to summary

applySelectorsAndFiltersFromSuite	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder applySelectorsAndFiltersFromSuite(Class<?> suiteClass) Apply a suite's annotation-based discovery selectors and filters to this builder. This will apply the configuration from the following annotations. `ExcludeClassNamePatterns` `ExcludeEngines` `ExcludePackages` `ExcludeTags` `IncludeClassNamePatterns` `IncludeEngines` `IncludePackages` `IncludeTags` `SelectClasses` `SelectClasspathResource` `SelectDirectories` `SelectFile` `SelectMethod` `SelectModules` `SelectUris` `SelectPackages` `Select` Parameters suiteClass:Class<?> the class to apply the discovery selectors and filter annotations from; never `null` Returns:SuiteLauncherDiscoveryRequestBuilder this builder for method chaining Since 1.11 See Also `org.junit.platform.suite.api.Suite`

pack-priv SuiteLauncherDiscoveryRequestBuilder applySelectorsAndFiltersFromSuite(Class<?> suiteClass)

Apply a suite's annotation-based discovery selectors and filters to this builder.

This will apply the configuration from the following annotations.

Parameters

suiteClass:Class<?>: the class to apply the discovery selectors and filter annotations from; never null

Returns:SuiteLauncherDiscoveryRequestBuilder

this builder for method chaining

Since

1.11

See Also

org.junit.platform.suite.api.Suite

build	back to summary
pack-priv LauncherDiscoveryRequest build() Build the `LauncherDiscoveryRequest` that has been configured via this builder.

configurationParameter back to summary

configurationParameter	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder configurationParameter(String key, String value) Add the supplied configuration parameter to the request. Parameters key:String the configuration parameter key under which to store the value; never `null` or blank value:String the value to store Returns:SuiteLauncherDiscoveryRequestBuilder this builder for method chaining

pack-priv SuiteLauncherDiscoveryRequestBuilder configurationParameter(String key, String value)

Add the supplied configuration parameter to the request.

Parameters

key:String: the configuration parameter key under which to store the value; never null or blank
value:String: the value to store

Returns:SuiteLauncherDiscoveryRequestBuilder

this builder for method chaining

configurationParametersResource	back to summary
pack-priv void configurationParametersResource(String resourceFile)

createIncludeClassNameFilter	back to summary
private ClassNameFilter createIncludeClassNameFilter(String... patterns)

disableImplicitConfigurationParameters back to summary

disableImplicitConfigurationParameters	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder disableImplicitConfigurationParameters() Configure whether implicit configuration parameters should be considered. By default, in addition to those parameters that are passed explicitly to this builder, configuration parameters are read from system properties and from the `junit-platform.properties` classpath resource. Passing `false` to this method, disables the latter two sources so that only explicit configuration parameters are taken into account. Returns:SuiteLauncherDiscoveryRequestBuilder this builder for method chaining See Also `configurationParameter(String, String)`

pack-priv SuiteLauncherDiscoveryRequestBuilder disableImplicitConfigurationParameters()

Configure whether implicit configuration parameters should be considered.

By default, in addition to those parameters that are passed explicitly to this builder, configuration parameters are read from system properties and from the junit-platform.properties classpath resource. Passing false to this method, disables the latter two sources so that only explicit configuration parameters are taken into account.

Returns:SuiteLauncherDiscoveryRequestBuilder: this builder for method chaining
See Also: configurationParameter(String, String)

filters back to summary

filters	back to summary
private void filters(Filter<?>... filters) Add all supplied `filters` to the request. The `filters` are combined using AND semantics, i.e. all of them have to include a resource for it to end up in the test plan. Warning be cautious when registering multiple competing `include` `EngineFilters` or multiple competing `exclude` `EngineFilters` for the same discovery request since doing so will likely lead to undesirable results (i.e., zero engines being active). Parameters filters:Filter<?>[] the `Filter`s to add; never `null`

private void filters(Filter<?>... filters)

Add all supplied filters to the request.

The filters are combined using AND semantics, i.e. all of them have to include a resource for it to end up in the test plan.

Warning

be cautious when registering multiple competing include EngineFilters or multiple competing exclude EngineFilters for the same discovery request since doing so will likely lead to undesirable results (i.e., zero engines being active).

Parameters

filters:Filter<?>[]: the Filters to add; never null

filterStandardClassNamePatterns back to summary

filterStandardClassNamePatterns	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder filterStandardClassNamePatterns() Specify whether to filter standard class name patterns. If set to `true`, standard class name patterns are filtered. Returns:SuiteLauncherDiscoveryRequestBuilder this builder for method chaining

pack-priv SuiteLauncherDiscoveryRequestBuilder filterStandardClassNamePatterns()

Specify whether to filter standard class name patterns.

If set to true, standard class name patterns are filtered.

Returns:SuiteLauncherDiscoveryRequestBuilder: this builder for method chaining

findAnnotationValues	back to summary
private static <A extends Annotation, V> Optional<V[]> findAnnotationValues(AnnotatedElement element, Class<A> annotationType, Function<A, V[]> valueExtractor)

listener	back to summary
pack-priv void listener(LauncherDiscoveryListener listener)

outputDirectoryCreator	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder outputDirectoryCreator(OutputDirectoryCreator outputDirectoryCreator)

parentConfigurationParameters back to summary

parentConfigurationParameters	back to summary
pack-priv SuiteLauncherDiscoveryRequestBuilder parentConfigurationParameters(ConfigurationParameters parentConfigurationParameters) Set the parent configuration parameters to use for the request. Any explicit configuration parameters configured via `configurationParameter(String, String)` takes precedence over the supplied configuration parameters. Parameters parentConfigurationParameters:ConfigurationParameters the parent instance to use for looking up configuration parameters that have not been explicitly configured; never `null` Returns:SuiteLauncherDiscoveryRequestBuilder this builder for method chaining See Also `configurationParameter(String, String)`

pack-priv SuiteLauncherDiscoveryRequestBuilder parentConfigurationParameters(ConfigurationParameters parentConfigurationParameters)

Set the parent configuration parameters to use for the request.

Any explicit configuration parameters configured via configurationParameter(String, String) takes precedence over the supplied configuration parameters.

Parameters

parentConfigurationParameters:ConfigurationParameters: the parent instance to use for looking up configuration parameters that have not been explicitly configured; never null

Returns:SuiteLauncherDiscoveryRequestBuilder

this builder for method chaining

prefixErrorMessageForInvalidSelectMethodUsage	back to summary
private static String prefixErrorMessageForInvalidSelectMethodUsage(Class<?> suiteClass, String detailMessage)

request back to summary

request	back to summary
pack-priv static SuiteLauncherDiscoveryRequestBuilder request() Create a new `SuiteLauncherDiscoveryRequestBuilder`. Returns:SuiteLauncherDiscoveryRequestBuilder a new builder

pack-priv static SuiteLauncherDiscoveryRequestBuilder request()

Create a new SuiteLauncherDiscoveryRequestBuilder.

Returns:SuiteLauncherDiscoveryRequestBuilder: a new builder

selectClasses	back to summary
private List<ClassSelector> selectClasses(Class<?> suiteClass, SelectClasses annotation)

selectMethod	back to summary
private MethodSelector selectMethod(Class<?> suiteClass, SelectMethod annotation)

selectors back to summary

selectors	back to summary
pack-priv void selectors(DiscoverySelector... selectors) Add all supplied `selectors` to the request. Parameters selectors:DiscoverySelector[] the `DiscoverySelectors` to add; never `null`

pack-priv void selectors(DiscoverySelector... selectors)

Add all supplied selectors to the request.

Parameters

selectors:DiscoverySelector[]: the DiscoverySelectors to add; never null

selectors back to summary

selectors	back to summary
private void selectors(List<? extends DiscoverySelector> selectors) Add all supplied `selectors` to the request. Parameters selectors:List<? extends DiscoverySelector> the `DiscoverySelectors` to add; never `null`

private void selectors(List<? extends DiscoverySelector> selectors)

Add all supplied selectors to the request.

Parameters

selectors:List<? extends DiscoverySelector>: the DiscoverySelectors to add; never null

stripped	back to summary
private static Optional<String[]> stripped(String[] patterns)

toClassSelectors	back to summary
private static Stream<ClassSelector> toClassSelectors(Class<?> suiteClass, SelectClasses annotation)

toMethodSelector	back to summary
private MethodSelector toMethodSelector(Class<?> suiteClass, SelectMethod annotation)

toMethodSelector	back to summary
private static MethodSelector toMethodSelector(Class<?> suiteClass, @Nullable Class<?> type, @Nullable String typeName, @Nullable Class<?>[] parameterTypes, String methodName, String parameterTypeNames)

toMethodSelectorFromFQMN	back to summary
private static MethodSelector toMethodSelectorFromFQMN(Class<?> suiteClass, SelectMethod annotation)

pack-priv final Class SuiteLauncherDiscoveryRequestBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail