Top Inners Fields Constructors Methods
org.junit.platform.console.options

public Class TestDiscoveryOptionsMixin

extends Object
Class Inheritance
Annotations
@API
status:INTERNAL
since:1.14
Static Imports
org.apiguardian.api.API.Status.INTERNAL

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class
public static class

Field Summary

Modifier and TypeField and Description
private static final String
pack-priv TestDiscoveryOptionsMixin.FilterOptions
pack-priv TestDiscoveryOptionsMixin.RuntimeConfigurationOptions
pack-priv TestDiscoveryOptionsMixin.SelectorOptions

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public TestDiscoveryOptions
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CP_OPTIONback to summary
private static final String CP_OPTION
filterOptionsback to summary
pack-priv TestDiscoveryOptionsMixin.FilterOptions filterOptions
Annotations
@ArgGroup
validate:false
order:3
heading:%n For more information on selectors including syntax examples, see%n @|underline https://docs.junit.org/${junit.docs.version}/user-guide/#running-tests-discovery-selectors|@%n%n@|bold FILTERS|@%n%n
runtimeConfigurationOptionsback to summary
pack-priv TestDiscoveryOptionsMixin.RuntimeConfigurationOptions runtimeConfigurationOptions
Annotations
@ArgGroup
validate:false
order:4
heading:%n@|bold RUNTIME CONFIGURATION|@%n%n
selectorOptionsback to summary
pack-priv TestDiscoveryOptionsMixin.SelectorOptions selectorOptions
Annotations
@ArgGroup
validate:false
order:2
heading:%n@|bold SELECTORS|@%n%n

Constructor Detail

TestDiscoveryOptionsMixinback to summary
public TestDiscoveryOptionsMixin()

Method Detail

toTestDiscoveryOptionsback to summary
public TestDiscoveryOptions toTestDiscoveryOptions()
org.junit.platform.console.options back to summary

public Class TestDiscoveryOptionsMixin.FilterOptions

extends Object
Class Inheritance
  • java.lang.Object
  • org.junit.platform.console.options.TestDiscoveryOptionsMixin.FilterOptions

Field Summary

Modifier and TypeField and Description
private final List<String>
private final List<String>
private final List<String>
private final List<String>
private final List<String>
private final List<String>
private final List<String>
private final List<String>
private final List<String>
private final List<String>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

excludeClassNamePatternsback to summary
private final List<String> excludeClassNamePatterns
Annotations
@Option
names:-N, --exclude-classname
paramLabel:PATTERN
arity:1
description:Provide a regular expression to exclude those classes whose fully qualified names match. When this option is repeated, all patterns will be combined using OR semantics.
excludedEnginesback to summary
private final List<String> excludedEngines
Annotations
@Option
names:-E, --exclude-engine
paramLabel:ID
arity:1
description:Provide the ID of an engine to be excluded from the test run. This option can be repeated.
excludedTagsback to summary
private final List<String> excludedTags
Annotations
@Option
names:-T, --exclude-tag
paramLabel:TAG
arity:1
description:Provide a tag or tag expression to exclude those tests whose tags match. When this option is repeated, all patterns will be combined using OR semantics.
excludeMethodNamePatternsback to summary
private final List<String> excludeMethodNamePatterns
Annotations
@Option
names:--exclude-methodname
paramLabel:PATTERN
arity:1
description:Provide a regular expression to exclude those methods whose fully qualified names without parameters match. When this option is repeated, all patterns will be combined using OR semantics.
excludePackagesback to summary
private final List<String> excludePackages
Annotations
@Option
names:--exclude-package
paramLabel:PKG
arity:1
description:Provide a package to be excluded from the test run. This option can be repeated.
includeClassNamePatternsback to summary
private final List<String> includeClassNamePatterns
Annotations
@Option
names:-n, --include-classname
paramLabel:PATTERN
defaultValue:^(Test.*|.+[.$]Test.*|.*Tests?)$
arity:1
description:Provide a regular expression to include only classes whose fully qualified names match. To avoid loading classes unnecessarily, the default pattern only includes class names that begin with "Test" or end with "Test" or "Tests". When this option is repeated, all patterns will be combined using OR semantics. Default: ${DEFAULT-VALUE}
includedEnginesback to summary
private final List<String> includedEngines
Annotations
@Option
names:-e, --include-engine
paramLabel:ID
arity:1
description:Provide the ID of an engine to be included in the test run. This option can be repeated.
includedTagsback to summary
private final List<String> includedTags
Annotations
@Option
names:-t, --include-tag
paramLabel:TAG
arity:1
description:Provide a tag or tag expression to include only tests whose tags match. When this option is repeated, all patterns will be combined using OR semantics.
includeMethodNamePatternsback to summary
private final List<String> includeMethodNamePatterns
Annotations
@Option
names:--include-methodname
paramLabel:PATTERN
arity:1
description:Provide a regular expression to include only methods whose fully qualified names without parameters match. When this option is repeated, all patterns will be combined using OR semantics.
includePackagesback to summary
private final List<String> includePackages
Annotations
@Option
names:--include-package
paramLabel:PKG
arity:1
description:Provide a package to be included in the test run. This option can be repeated.

Constructor Detail

FilterOptionsback to summary
public FilterOptions()

Method Detail

applyToback to summary
private void applyTo(TestDiscoveryOptions result)
org.junit.platform.console.options back to summary

public Class TestDiscoveryOptionsMixin.RuntimeConfigurationOptions

extends Object
Class Inheritance
  • java.lang.Object
  • org.junit.platform.console.options.TestDiscoveryOptionsMixin.RuntimeConfigurationOptions

Field Summary

Modifier and TypeField and Description
private final List<Path>
private final Map<String, String>
private List<String>
private CommandLine.Model.CommandSpec

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
public void
setConfigurationParameters(Map<String, String>
the key-value pairs to add
map
)

Adds the specified key-value pair (or pairs) to the configuration parameters.

private void
validateUnique(String key, String newValue)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

additionalClasspathEntriesback to summary
private final List<Path> additionalClasspathEntries
Annotations
@Option
names:-cp, --classpath, --class-path
converter:ClasspathEntriesConverter
paramLabel:PATH
arity:1
description:Provide additional classpath entries -- for example, for adding engines and their dependencies. This option can be repeated.
configurationParametersback to summary
private final Map<String, String> configurationParameters
configurationParametersResourcesback to summary
private List<String> configurationParametersResources
Annotations
@Option
names:--config-resource
paramLabel:PATH
arity:1
description:Set configuration parameters for test discovery and execution via a classpath resource. This option can be repeated.
specback to summary
private CommandLine.Model.CommandSpec spec
Annotations
@Spec

Constructor Detail

RuntimeConfigurationOptionsback to summary
public RuntimeConfigurationOptions()

Method Detail

applyToback to summary
private void applyTo(TestDiscoveryOptions result)
setConfigurationParametersback to summary
public void setConfigurationParameters(Map<String, String> map)

Adds the specified key-value pair (or pairs) to the configuration parameters. A ParameterException is thrown if the same key is specified multiple times on the command line.

Parameters
map:Map<String, String>

the key-value pairs to add

Annotations
@Option
names:--config
paramLabel:KEY=VALUE
arity:1
description:Set a configuration parameter for test discovery and execution. This option can be repeated.
Exceptions
ParameterException:
if the map already contains this key
See Also
#1308
validateUniqueback to summary
private void validateUnique(String key, String newValue)
org.junit.platform.console.options back to summary

public Class TestDiscoveryOptionsMixin.SelectorOptions

extends Object
Class Inheritance
  • java.lang.Object
  • org.junit.platform.console.options.TestDiscoveryOptionsMixin.SelectorOptions

Field Summary

Modifier and TypeField and Description
private boolean
private final List<ClassSelector>
private @Nullable List<Path>
private final List<ClasspathResourceSelector>
private final List<DirectorySelector>
private final List<FileSelector>
private final List<IterationSelector>
private final List<MethodSelector>
private final List<ModuleSelector>
private final List<PackageSelector>
private final List<UniqueIdSelector>
private final List<UriSelector>
private final List<DiscoverySelectorIdentifier>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
private void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

scanModulepathback to summary
private boolean scanModulepath
Annotations
@Option
names:--scan-modules
description:Scan all resolved modules for test discovery.
selectedClassesback to summary
private final List<ClassSelector> selectedClasses
Annotations
@Option
names:-c, --select-class
paramLabel:CLASS
arity:1..*
converter:Class
description:Select a class for test discovery. This option can be repeated.
selectedClasspathEntriesback to summary
private @Nullable List<Path> selectedClasspathEntries
Annotations
@Option
names:--scan-classpath, --scan-class-path
converter:ClasspathEntriesConverter
paramLabel:PATH
arity:0..1
description:Scan all directories on the classpath or explicit classpath roots. Without arguments, only directories on the system classpath as well as additional classpath entries supplied via -cp (directories and JAR files) are scanned. Explicit classpath roots that are not on the classpath will be silently ignored. This option can be repeated.
selectedClasspathResourcesback to summary
private final List<ClasspathResourceSelector> selectedClasspathResources
Annotations
@Option
names:-r, --select-resource
paramLabel:RESOURCE
arity:1..*
converter:ClasspathResource
description:Select a classpath resource for test discovery. This option can be repeated.
selectedDirectoriesback to summary
private final List<DirectorySelector> selectedDirectories
Annotations
@Option
names:-d, --select-directory
paramLabel:DIR
arity:1..*
converter:Directory
description:Select a directory for test discovery. This option can be repeated.
selectedFilesback to summary
private final List<FileSelector> selectedFiles
Annotations
@Option
names:-f, --select-file
paramLabel:FILE
arity:1..*
converter:File
description:Select a file for test discovery. The line and column numbers can be provided as URI query parameters (e.g. foo.txt?line=12&column=34). This option can be repeated.
selectedIterationsback to summary
private final List<IterationSelector> selectedIterations
Annotations
@Option
names:-i, --select-iteration
paramLabel:PREFIX:VALUE[INDEX(..INDEX)?(,INDEX(..INDEX)?)*]
arity:1..*
converter:Iteration
description:Select iterations for test discovery via a prefixed identifier and a list of indexes or index ranges (e.g. method:com.acme.Foo#m()[1..2] selects the first and second iteration of the m() method in the com.acme.Foo class). This option can be repeated.
selectedMethodsback to summary
private final List<MethodSelector> selectedMethods
Annotations
@Option
names:-m, --select-method
paramLabel:NAME
arity:1..*
converter:Method
description:Select a method for test discovery. This option can be repeated.
selectedModulesback to summary
private final List<ModuleSelector> selectedModules
Annotations
@Option
names:-o, --select-module
paramLabel:NAME
arity:1..*
converter:Module
description:Select single module for test discovery. This option can be repeated.
selectedPackagesback to summary
private final List<PackageSelector> selectedPackages
Annotations
@Option
names:-p, --select-package
paramLabel:PKG
arity:1..*
converter:Package
description:Select a package for test discovery. This option can be repeated.
selectedUniqueIdsback to summary
private final List<UniqueIdSelector> selectedUniqueIds
Annotations
@Option
names:--select-unique-id, --uid
paramLabel:UNIQUE-ID
arity:1..*
converter:UniqueId
description:Select a unique id for test discovery. This option can be repeated.
selectedUrisback to summary
private final List<UriSelector> selectedUris
Annotations
@Option
names:-u, --select-uri
paramLabel:URI
arity:1..*
converter:Uri
description:Select a URI for test discovery. This option can be repeated.
selectorIdentifiersback to summary
private final List<DiscoverySelectorIdentifier> selectorIdentifiers
Annotations
@Option
names:--select
paramLabel:PREFIX:VALUE
arity:1..*
converter:Identifier
description:Select via a prefixed identifier (e.g. method:com.acme.Foo#m selects the m() method in the com.acme.Foo class). This option can be repeated.

Constructor Detail

SelectorOptionsback to summary
pack-priv SelectorOptions()

Method Detail

applyToback to summary
private void applyTo(TestDiscoveryOptions result)