Class TestTag

java.lang.Object

org.junit.platform.engine.TestTag

All Implemented Interfaces:

Serializable

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

Immutable value object for a tag that is assigned to a test or container.

Since:

1.0

See Also:

• isValid(String)
• create(String)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	RESERVED_CHARACTERS	Reserved characters that are not permissible as part of a tag name.

Method Summary

Modifier and Type	Method	Description
static TestTag	create(String name)	Create a TestTag from the supplied name.
boolean	equals(Object obj)
String	getName()	Get the name of this tag.
int	hashCode()
static boolean	isValid(@Nullable String name)	Determine if the supplied tag name is valid with regard to the supported syntax for tags.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RESERVED_CHARACTERS

public static final Set<String> RESERVED_CHARACTERS

Reserved characters that are not permissible as part of a tag name.

• ,: comma
• (: left parenthesis
• ): right parenthesis
• &: ampersand
• |: vertical bar
• !: exclamation point

Method Details

isValid

public static boolean isValid(@Nullable String name)

Determine if the supplied tag name is valid with regard to the supported syntax for tags.

Syntax Rules for Tags

• A tag must not be null.
• A tag must not be blank.
• A stripped tag must not contain whitespace.
• A stripped tag must not contain ISO control characters.
• A stripped tag must not contain reserved characters.

If this method returns true for a given name, it is then a valid candidate for the create() factory method.

Parameters:

name - the name of the tag to validate; may be null or blank

Returns:

true if the supplied tag name conforms to the supported syntax for tags

See Also:

• StringUtils.isNotBlank(String)
• String.strip()
• StringUtils.doesNotContainWhitespace(String)
• StringUtils.doesNotContainIsoControlCharacter(String)
• RESERVED_CHARACTERS
• create(String)

create

public static TestTag create(String name)
                      throws PreconditionViolationException

Create a TestTag from the supplied name.

Consider checking whether the syntax of the supplied name is valid before attempting to create a TestTag using this factory method.

Note: the supplied name will be stripped.

Parameters:

name - the name of the tag; must be syntactically valid

Throws:

PreconditionViolationException - if the supplied tag name is not syntactically valid

See Also:

• isValid(String)

getName

public String getName()

Get the name of this tag.

Returns:

the name of this tag; never null or blank

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object