JUnit 5 5.10.2 · org.junit.platform.engine.TestTag

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

Access	Constructor and Description
private	TestTag(String name)

Modifier and Type	Method and Description
public static TestTag	create(String the name of the tag; must be syntactically valid name) Create a `TestTag` from the supplied `name`.
private static boolean	doesNotContainReservedCharacter(String str)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the name of this tag; never `null` or blank getName() Get the name of this tag.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static boolean	Returns: `true` if the supplied tag name conforms to the supported syntax for tags isValid(String the name of the tag to validate; may be `null` or blank name) Determine if the supplied tag name is valid with regard to the supported syntax for tags.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

name	back to summary
private final String name

RESERVED_CHARACTERS	back to summary
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

serialVersionUID	back to summary
private static final long serialVersionUID

TestTag	back to summary
private TestTag(String name)

Method Detail

create back to summary

create	back to summary
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 trimmed. Parameters name:String the name of the tag; must be syntactically valid Exceptions PreconditionViolationException: if the supplied tag name is not syntactically valid See Also `TestTag#isValid(String)`

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

Parameters

name:String: the name of the tag; must be syntactically valid

Exceptions

PreconditionViolationException:: if the supplied tag name is not syntactically valid

See Also

TestTag#isValid(String)

doesNotContainReservedCharacter	back to summary
private static boolean doesNotContainReservedCharacter(String str)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Get the name of this tag. Returns:String the name of this tag; never `null` or blank

public String getName()

Get the name of this tag.

Returns:String: the name of this tag; never null or blank

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isValid back to summary

isValid	back to summary
public static boolean isValid(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 trimmed tag must not contain whitespace. A trimmed tag must not contain ISO control characters. A trimmed 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:String the name of the tag to validate; may be `null` or blank Returns:boolean `true` if the supplied tag name conforms to the supported syntax for tags See Also `StringUtils#isNotBlank(String)`, `String#trim()`, `StringUtils#doesNotContainWhitespace(String)`, `StringUtils#doesNotContainIsoControlCharacter(String)`, `RESERVED_CHARACTERS`, `TestTag#create(String)`

public static boolean isValid(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 trimmed tag must not contain whitespace.
A trimmed tag must not contain ISO control characters.
A trimmed 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:String: the name of the tag to validate; may be null or blank

Returns:boolean

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

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations