Class EngineFilter

java.lang.Object

org.junit.platform.launcher.EngineFilter

All Implemented Interfaces:

Filter<TestEngine>

@API(status=STABLE,
     since="1.0")
public class EngineFilter
extends Object
implements Filter<TestEngine>

An EngineFilter is applied to all TestEngines before they are used.

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

Since:

1.0

See Also:

• includeEngines(String...)
• excludeEngines(String...)
• LauncherDiscoveryRequest

Method Summary

Modifier and Type	Method	Description
FilterResult	apply(TestEngine testEngine)	Apply this filter to the supplied object.
static EngineFilter	excludeEngines(String... engineIds)	Create a new exclude EngineFilter based on the supplied engine IDs.
static EngineFilter	excludeEngines(List<String> engineIds)	Create a new exclude EngineFilter based on the supplied engine IDs.
List<String>	getEngineIds()
static EngineFilter	includeEngines(String... engineIds)	Create a new include EngineFilter based on the supplied engine IDs.
static EngineFilter	includeEngines(List<String> engineIds)	Create a new include EngineFilter based on the supplied engine IDs.
boolean	isIncludeFilter()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Filter

toPredicate

Method Details

includeEngines

public static EngineFilter includeEngines(String... engineIds)

Create a new include EngineFilter based on the supplied engine IDs.

Only TestEngines with matching engine IDs will be included within the test discovery and execution.

Parameters:

engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank

See Also:

• includeEngines(String...)

includeEngines

public static EngineFilter includeEngines(List<String> engineIds)

Create a new include EngineFilter based on the supplied engine IDs.

Only TestEngines with matching engine IDs will be included within the test discovery and execution.

Parameters:

engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank

See Also:

• includeEngines(String...)

excludeEngines

public static EngineFilter excludeEngines(String... engineIds)

Create a new exclude EngineFilter based on the supplied engine IDs.

TestEngines with matching engine IDs will be excluded from test discovery and execution.

Parameters:

engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank

See Also:

• excludeEngines(List)

excludeEngines

public static EngineFilter excludeEngines(List<String> engineIds)

Create a new exclude EngineFilter based on the supplied engine IDs.

TestEngines with matching engine IDs will be excluded from test discovery and execution.

Parameters:

engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank

See Also:

• includeEngines(String...)

getEngineIds

@API(status=INTERNAL,
     since="1.9")
public List<String> getEngineIds()

isIncludeFilter

@API(status=INTERNAL,
     since="1.9")
public boolean isIncludeFilter()

apply

public FilterResult apply(TestEngine testEngine)

Description copied from interface: Filter

Apply this filter to the supplied object.

Specified by:

apply in interface Filter<TestEngine>

toString

public String toString()

Overrides:

toString in class Object