Module org.junit.platform.engine

Package org.junit.platform.engine.discovery

Interface ClassNameFilter

All Superinterfaces:

DiscoveryFilter<String>, Filter<String>

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

DiscoveryFilter that is applied to the name of a Class.

Since:

1.0

See Also:

• includeClassNamePatterns(String...)
• excludeClassNamePatterns(String...)
• PackageNameFilter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STANDARD_INCLUDE_PATTERN	Standard include pattern in the form of a regular expression that is used to match against fully qualified class names: "^(Test.*|.+[.$]Test.*|.*Tests?)$"

Method Summary

Static Methods

Modifier and Type	Method	Description
static ClassNameFilter	excludeClassNamePatterns(String... patterns)	Create a new exclude ClassNameFilter based on the supplied patterns.
static ClassNameFilter	includeClassNamePatterns(String... patterns)	Create a new include ClassNameFilter based on the supplied patterns.

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

apply, toPredicate

Field Details

STANDARD_INCLUDE_PATTERN

static final String STANDARD_INCLUDE_PATTERN

Standard include pattern in the form of a regular expression that is used to match against fully qualified class names: "^(Test.*|.+[.$]Test.*|.*Tests?)$"

This pattern matches against class names beginning with Test or ending with Test or Tests (in any package).

See Also:

• Constant Field Values

Method Details

includeClassNamePatterns

static ClassNameFilter includeClassNamePatterns(String... patterns)

Create a new include ClassNameFilter based on the supplied patterns.

The patterns are combined using OR semantics, i.e. if the fully qualified name of a class matches against at least one of the patterns, the class will be included in the result set.

Parameters:

patterns - regular expressions to match against fully qualified class names; never null, empty, or containing null

See Also:

• Class.getName()
• excludeClassNamePatterns(String...)

excludeClassNamePatterns

static ClassNameFilter excludeClassNamePatterns(String... patterns)

Create a new exclude ClassNameFilter based on the supplied patterns.

The patterns are combined using OR semantics, i.e. if the fully qualified name of a class matches against at least one of the patterns, the class will be excluded from the result set.

Parameters:

patterns - regular expressions to match against fully qualified class names; never null, empty, or containing null

See Also:

• Class.getName()
• includeClassNamePatterns(String...)