org.junit.gen5.launcher

Class TestIdentifier

java.lang.Object

org.junit.gen5.launcher.TestIdentifier

All Implemented Interfaces:

java.io.Serializable

@API(value=Experimental)
public final class TestIdentifier
extends java.lang.Object
implements java.io.Serializable

Immutable data transfer object that represents a test or container which is usually part of a TestPlan.

Since:

5.0

See Also:

TestPlan, Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static TestIdentifier	from(org.junit.gen5.engine.TestDescriptor testDescriptor)
java.lang.String	getDisplayName() Get the display name for the represented test or container.
java.lang.String	getName() Get the name for the represented test or container.
java.util.Optional<TestId>	getParentId() Get the unique ID of this identifier's parent, if available.
java.util.Optional<org.junit.gen5.engine.TestSource>	getSource() Get the source location of the represented test or container, if available.
java.util.Set<org.junit.gen5.engine.TestTag>	getTags() Get the set of tags of the represented test or container.
TestId	getUniqueId() Get the unique ID of the represented test or container.
int	hashCode()
boolean	isContainer() Returns true if this identifier represents a container.
boolean	isTest() Returns true if this identifier represents a test.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

from

public static TestIdentifier from(org.junit.gen5.engine.TestDescriptor testDescriptor)

getUniqueId

public TestId getUniqueId()

Get the unique ID of the represented test or container.

Uniqueness must be guaranteed across an entire test plan, regardless of how many engines are used behind the scenes.

getName

public java.lang.String getName()

Get the name for the represented test or container.

The name is a technical name for a test or container. It must not be parsed or processed besides being displayed to end-users.

getDisplayName

public java.lang.String getDisplayName()

Get the display name for the represented test or container.

The display name is a human-readable name for a test or container. It must not be parsed or processed besides being displayed to end-users.

isTest

public boolean isTest()

Returns true if this identifier represents a test.

isContainer

public boolean isContainer()

Returns true if this identifier represents a container.

getSource

public java.util.Optional<org.junit.gen5.engine.TestSource> getSource()

Get the source location of the represented test or container, if available.

See Also:

TestSource

getTags

public java.util.Set<org.junit.gen5.engine.TestTag> getTags()

Get the set of tags of the represented test or container.

See Also:

TestTag

getParentId

public java.util.Optional<TestId> getParentId()

Get the unique ID of this identifier's parent, if available.

An identifier without a parent ID is called a root.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object