Modifier and Type	Class and Description
public static enum	TestDescriptor.Type Supported types for `TestDescriptors`.
public static interface	TestDescriptor.Visitor Visitor for the tree-like `TestDescriptor` structure.

Method Summary

Modifier and Type	Method and Description
public default void	accept(TestDescriptor.Visitor the `Visitor` to accept; never `null` visitor) Accept a `Visitor` to the subtree starting with this descriptor.
public void	addChild(TestDescriptor the child to add to this descriptor; never `null` descriptor) Add a child to this descriptor.
public static boolean	Returns: `true` if the descriptor is a test, contains tests, or may later register tests dynamically containsTests(TestDescriptor the `TestDescriptor` to check for tests; never `null` testDescriptor) Determine if the supplied descriptor (or any of its descendants) is a test or may potentially register tests dynamically.
public Optional<? extends TestDescriptor>	findByUniqueId(UniqueId the `UniqueId` to search for; never `null` uniqueId) Find the descriptor with the supplied unique ID. The search algorithm begins with this descriptor and then searches through its descendants.
public default Set<? extends TestDescriptor>	getAncestors() Get the immutable set of all ancestors of this descriptor.
public Set<? extends TestDescriptor>	Returns: the set of children of this descriptor; neither `null` nor mutable, but potentially empty getChildren() Get the immutable set of children of this descriptor.
public default Set<? extends TestDescriptor>	getDescendants() Get the immutable set of all descendants of this descriptor.
public String	Returns: the display name for this descriptor; never `null` or blank getDisplayName() Get the display name for this descriptor.
public default String	Returns: the legacy reporting name; never `null` or blank getLegacyReportingName() Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.
public Optional<TestDescriptor>	getParent() Get the parent of this descriptor, if available.
public Optional<TestSource>	getSource() Get the source of the test or container described by this descriptor, if available.
public Set<TestTag>	Returns: the set of tags associated with this descriptor; never `null` but potentially empty getTags() Get the set of tags associated with this descriptor.
public TestDescriptor.Type	Returns: the descriptor type; never `null`. getType() Determine the `Type` of this descriptor.
public UniqueId	Returns: the `UniqueId` for this descriptor; never `null` getUniqueId() Get the unique identifier (UID) for this descriptor.
public default boolean	isContainer() Determine if this descriptor describes a container.
public default boolean	isRoot() Determine if this descriptor is a root descriptor.
public default boolean	isTest() Determine if this descriptor describes a test.
public default boolean	mayRegisterTests() Determine if this descriptor may register dynamic tests during execution.
public default void	prune() Remove this descriptor from the hierarchy unless it is a root or contains tests.
public void	removeChild(TestDescriptor the child to remove from this descriptor; never `null` descriptor) Remove a child from this descriptor.
public void	removeFromHierarchy() Remove this non-root descriptor from its parent and remove all the children from this descriptor.
public void	setParent(TestDescriptor the new parent of this descriptor; may be `null`. parent) Set the parent of this descriptor.

Method Detail

accept back to summary

accept	back to summary
public default void accept(TestDescriptor.Visitor visitor) Accept a `Visitor` to the subtree starting with this descriptor. Parameters visitor:TestDescriptor.Visitor the `Visitor` to accept; never `null`

public default void accept(TestDescriptor.Visitor visitor)

Accept a Visitor to the subtree starting with this descriptor.

Parameters

visitor:TestDescriptor.Visitor: the Visitor to accept; never null

addChild back to summary

addChild	back to summary
public void addChild(TestDescriptor descriptor) Add a child to this descriptor. Parameters descriptor:TestDescriptor the child to add to this descriptor; never `null`

public void addChild(TestDescriptor descriptor)

Add a child to this descriptor.

Parameters

descriptor:TestDescriptor: the child to add to this descriptor; never null

containsTests back to summary

containsTests	back to summary
public static boolean containsTests(TestDescriptor testDescriptor) Determine if the supplied descriptor (or any of its descendants) is a test or may potentially register tests dynamically. Parameters testDescriptor:TestDescriptor the `TestDescriptor` to check for tests; never `null` Returns:boolean `true` if the descriptor is a test, contains tests, or may later register tests dynamically

public static boolean containsTests(TestDescriptor testDescriptor)

Determine if the supplied descriptor (or any of its descendants) is a test or may potentially register tests dynamically.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor to check for tests; never null

Returns:boolean

true if the descriptor is a test, contains tests, or may later register tests dynamically

findByUniqueId back to summary

findByUniqueId	back to summary
public Optional<? extends TestDescriptor> findByUniqueId(UniqueId uniqueId) Find the descriptor with the supplied unique ID. The search algorithm begins with this descriptor and then searches through its descendants. Parameters uniqueId:UniqueId the `UniqueId` to search for; never `null`

public Optional<? extends TestDescriptor> findByUniqueId(UniqueId uniqueId)

Find the descriptor with the supplied unique ID.

The search algorithm begins with this descriptor and then searches through its descendants.

Parameters

uniqueId:UniqueId: the UniqueId to search for; never null

getAncestors back to summary

getAncestors	back to summary
public default Set<? extends TestDescriptor> getAncestors() Get the immutable set of all ancestors of this descriptor. An ancestor is the parent of this descriptor or the parent of one of its parents, recursively. Annotations @API status:STABLE since:1.10 See Also `getParent()`

public default Set<? extends TestDescriptor> getAncestors()

Get the immutable set of all ancestors of this descriptor.

An ancestor is the parent of this descriptor or the parent of one of its parents, recursively.

Annotations

@API
status:STABLE
since:1.10

See Also

getParent()

getChildren back to summary

getChildren	back to summary
public Set<? extends TestDescriptor> getChildren() Get the immutable set of children of this descriptor. Returns:Set<? extends TestDescriptor> the set of children of this descriptor; neither `null` nor mutable, but potentially empty See Also `getDescendants()`

public Set<? extends TestDescriptor> getChildren()

Get the immutable set of children of this descriptor.

Returns:Set<? extends TestDescriptor>: the set of children of this descriptor; neither null nor mutable, but potentially empty
See Also: getDescendants()

getDescendants back to summary

getDescendants	back to summary
public default Set<? extends TestDescriptor> getDescendants() Get the immutable set of all descendants of this descriptor. A descendant is a child of this descriptor or a child of one of its children, recursively. See Also `getChildren()`

public default Set<? extends TestDescriptor> getDescendants()

Get the immutable set of all descendants of this descriptor.

A descendant is a child of this descriptor or a child of one of its children, recursively.

See Also: getChildren()

getDisplayName back to summary

getDisplayName	back to summary
public String getDisplayName() Get the display name for this descriptor. A display name is a human-readable name for a test or container that is typically used for test reporting in IDEs and build tools. Display names may contain spaces, special characters, and emoji, and the format may be customized by `TestEngines` or potentially by end users as well. Consequently, display names should never be parsed; rather, they should be used for display purposes only. Returns:String the display name for this descriptor; never `null` or blank See Also `getSource()`

public String getDisplayName()

Get the display name for this descriptor.

A display name is a human-readable name for a test or container that is typically used for test reporting in IDEs and build tools. Display names may contain spaces, special characters, and emoji, and the format may be customized by TestEngines or potentially by end users as well. Consequently, display names should never be parsed; rather, they should be used for display purposes only.

Returns:String: the display name for this descriptor; never null or blank
See Also: getSource()

getLegacyReportingName back to summary

getLegacyReportingName	back to summary
public default String getLegacyReportingName() Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4. The default implementation delegates to `getDisplayName()`. Returns:String the legacy reporting name; never `null` or blank

public default String getLegacyReportingName()

Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.

The default implementation delegates to getDisplayName().

Returns:String: the legacy reporting name; never null or blank

getParent	back to summary
public Optional<TestDescriptor> getParent() Get the parent of this descriptor, if available.

getSource back to summary

getSource	back to summary
public Optional<TestSource> getSource() Get the source of the test or container described by this descriptor, if available. See Also `TestSource`

public Optional<TestSource> getSource()

Get the source of the test or container described by this descriptor, if available.

See Also: TestSource

getTags back to summary

getTags	back to summary
public Set<TestTag> getTags() Get the set of tags associated with this descriptor. Returns:Set<TestTag> the set of tags associated with this descriptor; never `null` but potentially empty See Also `TestTag`

public Set<TestTag> getTags()

Get the set of tags associated with this descriptor.

Returns:Set<TestTag>: the set of tags associated with this descriptor; never null but potentially empty
See Also: TestTag

getType back to summary

getType	back to summary
public TestDescriptor.Type getType() Determine the `Type` of this descriptor. Returns:TestDescriptor.Type the descriptor type; never `null`. See Also `isContainer()`, `isTest()`

public TestDescriptor.Type getType()

Determine the Type of this descriptor.

Returns:TestDescriptor.Type: the descriptor type; never null.
See Also: isContainer(), isTest()

getUniqueId back to summary

getUniqueId	back to summary
public UniqueId getUniqueId() Get the unique identifier (UID) for this descriptor. Uniqueness must be guaranteed across an entire test plan, regardless of how many engines are used behind the scenes. Returns:UniqueId the `UniqueId` for this descriptor; never `null`

public UniqueId getUniqueId()

Get the unique identifier (UID) for this descriptor.

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

Returns:UniqueId: the UniqueId for this descriptor; never null

isContainer back to summary

isContainer	back to summary
public default boolean isContainer() Determine if this descriptor describes a container. The default implementation delegates to `Type#isContainer()`.

public default boolean isContainer()

Determine if this descriptor describes a container.

The default implementation delegates to Type#isContainer().

isRoot	back to summary
public default boolean isRoot() Determine if this descriptor is a root descriptor. A root descriptor is a descriptor without a parent.

isRoot

back to summary

public default boolean isRoot()

Determine if this descriptor is a root descriptor.

A root descriptor is a descriptor without a parent.

isTest back to summary

isTest	back to summary
public default boolean isTest() Determine if this descriptor describes a test. The default implementation delegates to `Type#isTest()`.

public default boolean isTest()

Determine if this descriptor describes a test.

The default implementation delegates to Type#isTest().

mayRegisterTests back to summary

mayRegisterTests	back to summary
public default boolean mayRegisterTests() Determine if this descriptor may register dynamic tests during execution. The default implementation assumes tests are usually known during discovery and thus returns `false`.

public default boolean mayRegisterTests()

Determine if this descriptor may register dynamic tests during execution.

The default implementation assumes tests are usually known during discovery and thus returns false.

prune back to summary

prune	back to summary
public default void prune() Remove this descriptor from the hierarchy unless it is a root or contains tests. A concrete `TestEngine` may override this method in order to implement a different algorithm or to skip pruning altogether. See Also `isRoot()`, `containsTests(TestDescriptor)`, `removeFromHierarchy()`

public default void prune()

Remove this descriptor from the hierarchy unless it is a root or contains tests.

A concrete TestEngine may override this method in order to implement a different algorithm or to skip pruning altogether.

See Also: isRoot(), containsTests(TestDescriptor), removeFromHierarchy()

removeChild back to summary

removeChild	back to summary
public void removeChild(TestDescriptor descriptor) Remove a child from this descriptor. Parameters descriptor:TestDescriptor the child to remove from this descriptor; never `null`

public void removeChild(TestDescriptor descriptor)

Remove a child from this descriptor.

Parameters

descriptor:TestDescriptor: the child to remove from this descriptor; never null

removeFromHierarchy back to summary

removeFromHierarchy	back to summary
public void removeFromHierarchy() Remove this non-root descriptor from its parent and remove all the children from this descriptor. If this method is invoked on a root descriptor, this method must throw a `JUnitException` explaining that a root cannot be removed from the hierarchy.

public void removeFromHierarchy()

Remove this non-root descriptor from its parent and remove all the children from this descriptor.

If this method is invoked on a root descriptor, this method must throw a JUnitException explaining that a root cannot be removed from the hierarchy.

setParent back to summary

setParent	back to summary
public void setParent(TestDescriptor parent) Set the parent of this descriptor. Parameters parent:TestDescriptor the new parent of this descriptor; may be `null`.

public void setParent(TestDescriptor parent)

Set the parent of this descriptor.

Parameters

parent:TestDescriptor: the new parent of this descriptor; may be null.

org.junit.platform.engine back to summary

public final Enum TestDescriptor.Type

Class Inheritance

extends Enum<TestDescriptor.Type>

java.lang.Object
java.lang.Enum
org.junit.platform.engine.TestDescriptor.Type

Supported types for TestDescriptors.

Field Summary

Modifier and Type	Field and Description
public static final TestDescriptor.Type	CONTAINER Denotes that the `TestDescriptor` is for a container.
public static final TestDescriptor.Type	CONTAINER_AND_TEST Denotes that the `TestDescriptor` is for a test that may potentially also be a container.
public static final TestDescriptor.Type	TEST Denotes that the `TestDescriptor` is for a test.

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if this type represents a descriptor that can contain other descriptors isContainer()
public boolean	Returns: `true` if this type represents a descriptor for a test isTest()
public static TestDescriptor.Type	valueOf(String name)
public static TestDescriptor.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONTAINER	back to summary
public static final TestDescriptor.Type CONTAINER Denotes that the `TestDescriptor` is for a container.

CONTAINER_AND_TEST	back to summary
public static final TestDescriptor.Type CONTAINER_AND_TEST Denotes that the `TestDescriptor` is for a test that may potentially also be a container.

TEST	back to summary
public static final TestDescriptor.Type TEST Denotes that the `TestDescriptor` is for a test.

Constructor Detail

Type	back to summary
private Type()

Method Detail

isContainer	back to summary
public boolean isContainer() Returns:boolean `true` if this type represents a descriptor that can contain other descriptors

isTest	back to summary
public boolean isTest() Returns:boolean `true` if this type represents a descriptor for a test

valueOf	back to summary
public static TestDescriptor.Type valueOf(String name)

values	back to summary
public static TestDescriptor.Type[] values()

public Interface TestDescriptor

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum TestDescriptor.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface TestDescriptor.Visitor

Method Summary

Method Detail