Top Description Methods
org.junit.platform.engine.discovery

public Interface PackageNameFilter

extends DiscoveryFilter<String>
Known Direct Implementers
org.junit.platform.engine.discovery.ExcludePackageNameFilter, org.junit.platform.engine.discovery.IncludePackageNameFilter
Annotations
@API
status:STABLE
since:1.0
Static Imports
org.apiguardian.api.API.Status.STABLE

DiscoveryFilter that is applied to the name of a Package.
Since
1.0
See Also
includePackageNames(String...), excludePackageNames(String...), ClassNameFilter

Method Summary

Modifier and TypeMethod and Description
public static PackageNameFilter
excludePackageNames(String...
package names that we be compared against fully qualified package names; never null, empty, or containing null
names
)

Create a new exclude PackageNameFilter based on the supplied package names.

public static PackageNameFilter
excludePackageNames(List<String>
package names that we be compared against fully qualified package names; never null, empty, or containing null
names
)

Create a new exclude PackageNameFilter based on the supplied package names.

public static PackageNameFilter
includePackageNames(String...
package names that we be compared against fully qualified package names; never null, empty, or containing null
names
)

Create a new include PackageNameFilter based on the supplied package names.

public static PackageNameFilter
includePackageNames(List<String>
package names that we be compared against fully qualified package names; never null, empty, or containing null
names
)

Create a new include PackageNameFilter based on the supplied package names.

Method Detail

excludePackageNamesback to summary
public static PackageNameFilter excludePackageNames(String... names)

Create a new exclude PackageNameFilter based on the supplied package names.

The names are combined using OR semantics, i.e. if the fully qualified name of a package starts with at least one of the names, the package will be excluded in the result set.

Parameters
names:String[]

package names that we be compared against fully qualified package names; never null, empty, or containing null

See Also
Package#getName(), excludePackageNames(List), includePackageNames(String...)
excludePackageNamesback to summary
public static PackageNameFilter excludePackageNames(List<String> names)

Create a new exclude PackageNameFilter based on the supplied package names.

The names are combined using OR semantics, i.e. if the fully qualified name of a package starts with at least one of the names, the package will be excluded in the result set.

Parameters
names:List<String>

package names that we be compared against fully qualified package names; never null, empty, or containing null

See Also
Package#getName(), excludePackageNames(String...), includePackageNames(String...)
includePackageNamesback to summary
public static PackageNameFilter includePackageNames(String... names)

Create a new include PackageNameFilter based on the supplied package names.

The names are combined using OR semantics, i.e. if the fully qualified name of a package starts with at least one of the names, the package will be included in the result set.

Parameters
names:String[]

package names that we be compared against fully qualified package names; never null, empty, or containing null

See Also
Package#getName(), includePackageNames(List), excludePackageNames(String...)
includePackageNamesback to summary
public static PackageNameFilter includePackageNames(List<String> names)

Create a new include PackageNameFilter based on the supplied package names.

The names are combined using OR semantics, i.e. if the fully qualified name of a package starts with at least one of the names, the package will be included in the result set.

Parameters
names:List<String>

package names that we be compared against fully qualified package names; never null, empty, or containing null

See Also
Package#getName(), includePackageNames(String...), excludePackageNames(String...)