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 or tag expressions.

Tag expressions are boolean expressions with the following allowed operators: ! (not), & (and), and | (or). Parentheses can be used to adjust for operator precedence. Please refer to the JUnit 5 User Guide for usage examples.

Please note that a tag name is a valid tag expression. Thus, wherever a tag expression can be used, a single tag name can also be used.

Since:

1.0

See Also:

• includeTags(String...)
• excludeTags(String...)
• TestTag

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TagFilter()

Method Summary

Modifier and Type	Method	Description
private static PostDiscoveryFilter	excludeMatching(List<String> tagExpressions)
static PostDiscoveryFilter	excludeTags(String... tagExpressions)	Create an exclude filter based on the supplied tag expressions.
static PostDiscoveryFilter	excludeTags(List<String> tagExpressions)	Create an exclude filter based on the supplied tag expressions.
private static String	exclusionReasonExpressionNotSatisfy(List<String> tagExpressions)
private static String	exclusionReasonExpressionSatisfy(List<String> tagExpressions)
private static String	formatToString(List<String> tagExpressions)
private static PostDiscoveryFilter	includeMatching(List<String> tagExpressions)
static PostDiscoveryFilter	includeTags(String... tagExpressions)	Create an include filter based on the supplied tag expressions.
static PostDiscoveryFilter	includeTags(List<String> tagExpressions)	Create an include filter based on the supplied tag expressions.
private static String	inclusionReasonExpressionNotSatisfy(List<String> tagExpressions)
private static String	inclusionReasonExpressionSatisfy(List<String> tagExpressions)
private static TagExpression	parse(String tagExpression)
private static List<TagExpression>	parseAll(List<String> tagExpressions)

Methods inherited from class Object

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

Constructor Details

TagFilter

private TagFilter()

Method Details

includeTags

public static PostDiscoveryFilter includeTags(String... tagExpressions)
                                       throws org.junit.platform.commons.PreconditionViolationException

Create an include filter based on the supplied tag expressions.

Containers and tests will only be executed if their tags match at least one of the supplied included tag expressions.

Parameters:

tagExpressions - the included tag expressions; never null or empty

Throws:

org.junit.platform.commons.PreconditionViolationException - if the supplied tag expressions array is null or empty, or if any individual tag expression is not syntactically valid

See Also:

• includeTags(List)
• TestTag.isValid(String)

includeTags

public static PostDiscoveryFilter includeTags(List<String> tagExpressions)
                                       throws org.junit.platform.commons.PreconditionViolationException

Create an include filter based on the supplied tag expressions.

Containers and tests will only be executed if their tags match at least one of the supplied included tag expressions.

Parameters:

tagExpressions - the included tag expressions; never null or empty

Throws:

org.junit.platform.commons.PreconditionViolationException - if the supplied tag expressions array is null or empty, or if any individual tag expression is not syntactically valid

See Also:

• includeTags(String...)
• TestTag.isValid(String)

excludeTags

public static PostDiscoveryFilter excludeTags(String... tagExpressions)
                                       throws org.junit.platform.commons.PreconditionViolationException

Create an exclude filter based on the supplied tag expressions.

Containers and tests will only be executed if their tags do not match any of the supplied excluded tag expressions.

Parameters:

tagExpressions - the excluded tag expressions; never null or empty

Throws:

org.junit.platform.commons.PreconditionViolationException - if the supplied tag expressions array is null or empty, or if any individual tag expression is not syntactically valid

See Also:

• excludeTags(List)
• TestTag.isValid(String)

excludeTags

public static PostDiscoveryFilter excludeTags(List<String> tagExpressions)
                                       throws org.junit.platform.commons.PreconditionViolationException

Create an exclude filter based on the supplied tag expressions.

Containers and tests will only be executed if their tags do not match any of the supplied excluded tag expressions.

Parameters:

tagExpressions - the excluded tag expressions; never null or empty

Throws:

org.junit.platform.commons.PreconditionViolationException - if the supplied tag expressions array is null or empty, or if any individual tag expression is not syntactically valid

See Also:

• excludeTags(String...)
• TestTag.isValid(String)

includeMatching

private static PostDiscoveryFilter includeMatching(List<String> tagExpressions)

inclusionReasonExpressionSatisfy

private static String inclusionReasonExpressionSatisfy(List<String> tagExpressions)

exclusionReasonExpressionNotSatisfy

private static String exclusionReasonExpressionNotSatisfy(List<String> tagExpressions)

excludeMatching

private static PostDiscoveryFilter excludeMatching(List<String> tagExpressions)

inclusionReasonExpressionNotSatisfy

private static String inclusionReasonExpressionNotSatisfy(List<String> tagExpressions)

exclusionReasonExpressionSatisfy

private static String exclusionReasonExpressionSatisfy(List<String> tagExpressions)

formatToString

private static String formatToString(List<String> tagExpressions)

parseAll

private static List<TagExpression> parseAll(List<String> tagExpressions)

parse

private static TagExpression parse(String tagExpression)