org.junit.platform.launcher

Class TagFilter

java.lang.Object

org.junit.platform.launcher.TagFilter

@API(status=STABLE,
     since="1.0")
public final class TagFilter
extends Object

Factory methods for creating PostDiscoveryFilters based on included and excluded tags.

Since:

1.0

See Also:

includeTags(String...), excludeTags(String...)

Method Summary

Modifier and Type	Method and Description
static PostDiscoveryFilter	excludeTags(List<String> tags) Create an exclude filter based on the supplied tags.
static PostDiscoveryFilter	excludeTags(String... tags) Create an exclude filter based on the supplied tags.
static PostDiscoveryFilter	includeTags(List<String> tags) Create an include filter based on the supplied tags.
static PostDiscoveryFilter	includeTags(String... tags) Create an include filter based on the supplied tags.

Methods inherited from class java.lang.Object

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

Method Detail

includeTags

public static PostDiscoveryFilter includeTags(String... tags)
                                       throws PreconditionViolationException

Create an include filter based on the supplied tags.

Note: each tag will be trimmed.

Containers and tests will only be executed if they are tagged with at least one of the supplied included tags.

Parameters:

tags - the included tags; never null or empty

Throws:

PreconditionViolationException - if the supplied tags array is null or empty, or if any individual tag is not syntactically valid

See Also:

includeTags(List), TestTag.isValid(String)

includeTags

public static PostDiscoveryFilter includeTags(List<String> tags)
                                       throws PreconditionViolationException

Create an include filter based on the supplied tags.

Note: each tag will be trimmed.

Containers and tests will only be executed if they are tagged with at least one of the supplied included tags.

Parameters:

tags - the included tags; never null or empty

Throws:

PreconditionViolationException - if the supplied tags list is null or empty, or if any individual tag is not syntactically valid

See Also:

includeTags(String...), TestTag.isValid(String)

excludeTags

public static PostDiscoveryFilter excludeTags(String... tags)
                                       throws PreconditionViolationException

Create an exclude filter based on the supplied tags.

Note: each tag will be trimmed.

Containers and tests will only be executed if they are not tagged with any of the supplied excluded tags.

Parameters:

tags - the excluded tags; never null or empty

Throws:

PreconditionViolationException - if the supplied tags array is null or empty, or if any individual tag is not syntactically valid

See Also:

excludeTags(List), TestTag.isValid(String)

excludeTags

public static PostDiscoveryFilter excludeTags(List<String> tags)
                                       throws PreconditionViolationException

Create an exclude filter based on the supplied tags.

Note: each tag will be trimmed.

Containers and tests will only be executed if they are not tagged with any of the supplied excluded tags.

Parameters:

tags - the excluded tags; never null or empty

Throws:

PreconditionViolationException - if the supplied tags list is null or empty, or if any individual tag is not syntactically valid

See Also:

excludeTags(String...), TestTag.isValid(String)