org.junit.jupiter.engine.descriptor

Class ClassBasedContainerExtensionContext

java.lang.Object

org.junit.jupiter.engine.descriptor.ClassBasedContainerExtensionContext

All Implemented Interfaces:

ContainerExtensionContext, ExtensionContext

@API(value=Internal)
public final class ClassBasedContainerExtensionContext
extends Object
implements ContainerExtensionContext

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.ExtensionContext

ExtensionContext.Namespace, ExtensionContext.Store

Constructor Summary

Constructors

Constructor and Description
ClassBasedContainerExtensionContext(ExtensionContext parent, EngineExecutionListener engineExecutionListener, ClassTestDescriptor testDescriptor)

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Get the display name for the current test or container.
Optional<AnnotatedElement>	getElement() Get the AnnotatedElement corresponding to the current extension context, if available.
Optional<ExtensionContext>	getParent() Get the parent extension context, if available.
ExtensionContext.Store	getStore(ExtensionContext.Namespace namespace) Get the ExtensionContext.Store for the supplied ExtensionContext.Namespace.
Set<String>	getTags() Get the set of all tags for the current test or container.
Optional<Class<?>>	getTestClass() Get the Class associated with the current test or container, if available.
protected T	getTestDescriptor()
Optional<Method>	getTestMethod() Get the Method associated with the current test, if available.
String	getUniqueId() Get the unique ID of the current test or container.
void	publishReportEntry(Map<String,String> values) Publish a map of key-value pairs to be consumed by an org.junit.platform.engine.EngineExecutionListener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.junit.jupiter.api.extension.ExtensionContext

getDisplayName, getParent, getStore, getStore, getTags, getUniqueId, publishReportEntry, publishReportEntry

Constructor Detail

ClassBasedContainerExtensionContext

public ClassBasedContainerExtensionContext(ExtensionContext parent,
                                           EngineExecutionListener engineExecutionListener,
                                           ClassTestDescriptor testDescriptor)

Method Detail

getElement

public Optional<AnnotatedElement> getElement()

Description copied from interface: ExtensionContext

Get the AnnotatedElement corresponding to the current extension context, if available.

For example, if the current extension context encapsulates a test class or test method, the annotated element will be the corresponding Class or Method reference.

Favor this method over more specific methods whenever the AnnotatedElement API suits the task at hand — for example, when looking up annotations regardless of concrete element type.

Specified by:

getElement in interface ExtensionContext

Returns:

an Optional containing the AnnotatedElement; never null but potentially empty

See Also:

ExtensionContext.getTestClass(), ExtensionContext.getTestMethod()

getTestClass

public Optional<Class<?>> getTestClass()

Description copied from interface: ExtensionContext

Get the Class associated with the current test or container, if available.

Specified by:

getTestClass in interface ExtensionContext

Returns:

an Optional containing the class; never null but potentially empty

getTestMethod

public Optional<Method> getTestMethod()

Description copied from interface: ExtensionContext

Get the Method associated with the current test, if available.

Specified by:

getTestMethod in interface ExtensionContext

Returns:

an Optional containing the method; never null but potentially empty

getUniqueId

public String getUniqueId()

Description copied from interface: ExtensionContext

Get the unique ID of the current test or container.

Specified by:

getUniqueId in interface ExtensionContext

Returns:

the unique ID of the test or container; never null or blank

getDisplayName

public String getDisplayName()

Description copied from interface: ExtensionContext

Get the display name for the current test or container.

The display name is either a default name or a custom name configured via @DisplayName.

For details on default display names consult the Javadoc for TestInfo.getDisplayName().

Note that display names are typically used for test reporting in IDEs and build tools and may contain spaces, special characters, and even emoji.

Specified by:

getDisplayName in interface ExtensionContext

Returns:

the display name of the test or container; never null or blank

publishReportEntry

public void publishReportEntry(Map<String,String> values)

Description copied from interface: ExtensionContext

Publish a map of key-value pairs to be consumed by an org.junit.platform.engine.EngineExecutionListener.

Specified by:

publishReportEntry in interface ExtensionContext

Parameters:

values - the key-value pairs to be published; never null; keys and values within entries in the map also must not be null or blank

getParent

public Optional<ExtensionContext> getParent()

Description copied from interface: ExtensionContext

Get the parent extension context, if available.

Specified by:

getParent in interface ExtensionContext

Returns:

an Optional containing the parent; never null but potentially empty

getTestDescriptor

protected T getTestDescriptor()

getStore

public ExtensionContext.Store getStore(ExtensionContext.Namespace namespace)

Description copied from interface: ExtensionContext

Get the ExtensionContext.Store for the supplied ExtensionContext.Namespace.

Specified by:

getStore in interface ExtensionContext

Parameters:

namespace - the Namespace to get the store for; never null

Returns:

the store in which to put and get objects for other invocations working in the same namespace; never null

getTags

public Set<String> getTags()

Description copied from interface: ExtensionContext

Get the set of all tags for the current test or container.

Tags may be declared directly on the test element or inherited from an outer context.

Specified by:

getTags in interface ExtensionContext

Returns:

the set of tags for the test or container; never null but potentially empty