Module org.junit.platform.engine

Package org.junit.platform.engine.discovery

Interface PackageNameFilter

All Superinterfaces:

DiscoveryFilter<String>, Filter<String>

@API(status=STABLE,
     since="1.0")
public interface PackageNameFilter
extends DiscoveryFilter<String>

DiscoveryFilter that is applied to the name of a Package.

Since:

1.0

See Also:

• includePackageNames(String...)
• excludePackageNames(String...)
• ClassNameFilter

Method Summary

Static Methods

Modifier and Type	Method	Description
static PackageNameFilter	excludePackageNames(String... names)	Create a new exclude PackageNameFilter based on the supplied package names.
static PackageNameFilter	excludePackageNames(List<String> names)	Create a new exclude PackageNameFilter based on the supplied package names.
static PackageNameFilter	includePackageNames(String... names)	Create a new include PackageNameFilter based on the supplied package names.
static PackageNameFilter	includePackageNames(List<String> names)	Create a new include PackageNameFilter based on the supplied package names.

Methods inherited from interface org.junit.platform.engine.Filter

apply, toPredicate

Method Details

includePackageNames

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 - 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...)

includePackageNames

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 - 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...)

excludePackageNames

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 - 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...)

excludePackageNames

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 - 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...)