@API(status=STABLE, since="1.0") public final class TagFilter extends Object
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.
includeTags(String...)
,
excludeTags(String...)
,
TestTag
Modifier and Type | Method and Description |
---|---|
static PostDiscoveryFilter |
excludeTags(List<String> tagExpressions)
Create an exclude filter based on the supplied tag expressions.
|
static PostDiscoveryFilter |
excludeTags(String... tagExpressions)
Create an exclude filter based on the supplied tag expressions.
|
static PostDiscoveryFilter |
includeTags(List<String> tagExpressions)
Create an include filter based on the supplied tag expressions.
|
static PostDiscoveryFilter |
includeTags(String... tagExpressions)
Create an include filter based on the supplied tag expressions.
|
public static PostDiscoveryFilter includeTags(String... tagExpressions) throws PreconditionViolationException
Containers and tests will only be executed if their tags match at least one of the supplied included tag expressions.
tagExpressions
- the included tag expressions; never null
or
emptyPreconditionViolationException
- if the supplied tag expressions
array is null
or empty, or if any individual tag expression is
not syntactically validincludeTags(List)
,
TestTag.isValid(String)
public static PostDiscoveryFilter includeTags(List<String> tagExpressions) throws PreconditionViolationException
Containers and tests will only be executed if their tags match at least one of the supplied included tag expressions.
tagExpressions
- the included tag expressions; never null
or
emptyPreconditionViolationException
- if the supplied tag expressions
array is null
or empty, or if any individual tag expression is
not syntactically validincludeTags(String...)
,
TestTag.isValid(String)
public static PostDiscoveryFilter excludeTags(String... tagExpressions) throws PreconditionViolationException
Containers and tests will only be executed if their tags do not match any of the supplied excluded tag expressions.
tagExpressions
- the excluded tag expressions; never null
or
emptyPreconditionViolationException
- if the supplied tag expressions
array is null
or empty, or if any individual tag expression is
not syntactically validexcludeTags(List)
,
TestTag.isValid(String)
public static PostDiscoveryFilter excludeTags(List<String> tagExpressions) throws PreconditionViolationException
Containers and tests will only be executed if their tags do not match any of the supplied excluded tag expressions.
tagExpressions
- the excluded tag expressions; never null
or
emptyPreconditionViolationException
- if the supplied tag expressions
array is null
or empty, or if any individual tag expression is
not syntactically validexcludeTags(String...)
,
TestTag.isValid(String)
Copyright © 2021. All rights reserved.