MethodBasedTestExtensionContext (JUnit 5.0.0-M2 API)

java.lang.Object
- org.junit.jupiter.engine.descriptor.MethodBasedTestExtensionContext

All Implemented Interfaces:: ExtensionContext, TestExtensionContext

@API(value=Internal)
public final class MethodBasedTestExtensionContext
extends java.lang.Object
implements TestExtensionContext

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
`MethodBasedTestExtensionContext(ExtensionContext parent, EngineExecutionListener engineExecutionListener, MethodTestDescriptor testDescriptor, java.lang.Object testInstance, ThrowableCollector throwableCollector)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDisplayName()` Get the display name for the current test or container.
`java.util.Optional<java.lang.reflect.AnnotatedElement>`	`getElement()` Get the `AnnotatedElement` corresponding to the current extension context, if available.
`java.util.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`.
`java.util.Set<java.lang.String>`	`getTags()` Get the set of all tags for the current test or container.
`java.util.Optional<java.lang.Class<?>>`	`getTestClass()` Get the `Class` associated with the current test or container, if available.
`protected T`	`getTestDescriptor()`
`java.util.Optional<java.lang.Throwable>`	`getTestException()` Get the exception that was thrown during execution of the test associated with this `TestExtensionContext`, if available.
`java.lang.Object`	`getTestInstance()` Get the test instance associated with this `TestExtensionContext`.
`java.util.Optional<java.lang.reflect.Method>`	`getTestMethod()` Get the `Method` associated with the current test, if available.
`java.lang.String`	`getUniqueId()` Get the unique ID of the current test or container.
`void`	`publishReportEntry(java.util.Map<java.lang.String,java.lang.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
getParent, getStore, getStore, getTags, publishReportEntry

- Constructor Detail
  - MethodBasedTestExtensionContext
```
public MethodBasedTestExtensionContext(ExtensionContext parent,
                                       EngineExecutionListener engineExecutionListener,
                                       MethodTestDescriptor testDescriptor,
                                       java.lang.Object testInstance,
                                       ThrowableCollector throwableCollector)
```
- Method Detail
  - getUniqueId
```
public java.lang.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 java.lang.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
  - getElement
```
public java.util.Optional<java.lang.reflect.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 java.util.Optional<java.lang.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 java.util.Optional<java.lang.reflect.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
  - getTestInstance
```
public java.lang.Object getTestInstance()
```
    Description copied from interface: TestExtensionContext
    
    Get the test instance associated with this TestExtensionContext.
    
    Specified by:
    
    getTestInstance in interface TestExtensionContext
    
    Returns:
    
    the test instance; never null
  - getTestException
```
public java.util.Optional<java.lang.Throwable> getTestException()
```
    Description copied from interface: TestExtensionContext
    
    Get the exception that was thrown during execution of the test associated with this TestExtensionContext, if available.
    This method is typically used for logging and tracing purposes. If you wish to actually handle an exception thrown during test execution, implement the TestExecutionExceptionHandler API.
    Unlike the exception passed to a TestExecutionExceptionHandler, a test exception returned by this method can be any exception thrown during the invocation of a @Test method, its surrounding @BeforeEach and @AfterEach methods, or a test-level Extension. Note, however, that this method will never return an exception swallowed by a TestExecutionExceptionHandler. Furthermore, if multiple exceptions have been thrown during test execution, the exception returned by this method will be the first such exception with all additional exceptions suppressed in the first one.
    
    Specified by:
    
    getTestException in interface TestExtensionContext
    
    Returns:
    
    an Optional containing the exception thrown; never null but potentially empty if test execution has not (yet) resulted in an exception
  - publishReportEntry
```
public void publishReportEntry(java.util.Map<java.lang.String,java.lang.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 java.util.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 java.util.Set<java.lang.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

Class MethodBasedTestExtensionContext

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodBasedTestExtensionContext

Method Detail

getUniqueId

getDisplayName

getElement

getTestClass

getTestMethod

getTestInstance

getTestException

publishReportEntry

getParent

getTestDescriptor

getStore

getTags