Modifier and Type	Class and Description
pack-priv static class	TempDirectory.CloseablePath References Deprecated `ExtensionContext.Store.CloseableResource` is deprecated or references (maybe indirectly) at least one deprecated element.
private static record	TempDirectory.FailureTracker References Deprecated `ExtensionContext.Store.CloseableResource` is deprecated or references (maybe indirectly) at least one deprecated element.
private static record	TempDirectory.FieldContext
pack-priv static interface	TempDirectory.FileOperations

Modifier and Type	Field and Description
private static final String	CHILD_FAILED
private final JupiterConfiguration	configuration
private static final String	FAILURE_TRACKER
pack-priv static final String	FILE_OPERATIONS_KEY
private static final String	KEY
pack-priv static final ExtensionContext.Namespace	NAMESPACE

Access	Constructor and Description
pack-priv	TempDirectory(JupiterConfiguration configuration)

Modifier and Type	Method and Description
private static void	assertNonFinalField(Field field)
private static void	assertSupportedType(String target, Class<?> type)
public void	beforeAll(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll. Perform field injection for non-private, `static` fields (i.e., class fields) of type `Path` or `File` that are annotated with `@TempDir`.
public void	beforeEach(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach. Perform field injection for non-private, non-static fields (i.e., instance fields) of type `Path` or `File` that are annotated with `@TempDir`.
pack-priv static TempDirectory.CloseablePath	createTempDir(TempDirFactory factory, CleanupMode cleanupMode, Class<?> elementType, AnnotatedElementContext elementContext, ExtensionContext extensionContext) References Deprecated `TempDirectory.CloseablePath` is deprecated or references (maybe indirectly) at least one deprecated element.
private CleanupMode	determineCleanupMode(TempDir tempDir)
private CleanupMode	determineCleanupModeForField(Field field)
private CleanupMode	determineCleanupModeForParameter(ParameterContext parameterContext)
private TempDirFactory	determineTempDirFactory(TempDir tempDir)
private TempDirFactory	determineTempDirFactoryForField(Field field)
private TempDirFactory	determineTempDirFactoryForParameter(ParameterContext parameterContext)
private static ExtensionContext.Store	getContextSpecificStore(ExtensionContext context)
private static Object	getPathOrFile(Class<?> elementType, AnnotatedElementContext elementContext, TempDirFactory factory, CleanupMode cleanupMode, ExtensionContext extensionContext)
public TestInstantiationAwareExtension.ExtensionContextScope	getTestInstantiationExtensionContextScope(ExtensionContext rootContext) Overrides default org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope. Determine whether this extension should receive a test-method scoped `ExtensionContext` during the instantiation of test classes or processing of test instances.
private void	injectFields(ExtensionContext context, @Nullable Object testInstance, Class<?> testClass, Predicate<Field> predicate)
private void	injectInstanceFields(ExtensionContext context, Object instance)
private void	injectStaticFields(ExtensionContext context, Class<?> testClass)
private static void	installFailureTracker(ExtensionContext context)
private static void	installFailureTracker(ExtensionContext context, ExtensionContext parentContext)
public Object	resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Implements org.junit.jupiter.api.extension.ParameterResolver.resolveParameter. Resolve the current temporary directory for the `Parameter` in the supplied `ParameterContext`.
private static boolean	selfOrChildFailed(ExtensionContext context)
public boolean	supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Implements org.junit.jupiter.api.extension.ParameterResolver.supportsParameter. Determine if the `Parameter` in the supplied `ParameterContext` is annotated with `@TempDir`.

CHILD_FAILED	back to summary
private static final String CHILD_FAILED

configuration	back to summary
private final JupiterConfiguration configuration

FAILURE_TRACKER	back to summary
private static final String FAILURE_TRACKER

FILE_OPERATIONS_KEY	back to summary
pack-priv static final String FILE_OPERATIONS_KEY

KEY	back to summary
private static final String KEY

NAMESPACE	back to summary
pack-priv static final ExtensionContext.Namespace NAMESPACE

TempDirectory	back to summary
pack-priv TempDirectory(JupiterConfiguration configuration)

Method Detail

assertNonFinalField	back to summary
private static void assertNonFinalField(Field field)

assertSupportedType	back to summary
private static void assertSupportedType(String target, Class<?> type)

beforeAll back to summary

beforeAll	back to summary
public void beforeAll(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll. Perform field injection for non-private, `static` fields (i.e., class fields) of type `Path` or `File` that are annotated with `@TempDir`. Annotations @Override

public void beforeAll(ExtensionContext context)

Implements org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll.

Perform field injection for non-private, static fields (i.e., class fields) of type Path or File that are annotated with @TempDir.

Annotations

@Override

beforeEach back to summary

beforeEach	back to summary
public void beforeEach(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach. Perform field injection for non-private, non-static fields (i.e., instance fields) of type `Path` or `File` that are annotated with `@TempDir`. Annotations @Override

public void beforeEach(ExtensionContext context)

Implements org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach.

Perform field injection for non-private, non-static fields (i.e., instance fields) of type Path or File that are annotated with @TempDir.

Annotations

@Override

createTempDir	back to summary
pack-priv static TempDirectory.CloseablePath createTempDir(TempDirFactory factory, CleanupMode cleanupMode, Class<?> elementType, AnnotatedElementContext elementContext, ExtensionContext extensionContext) References Deprecated `TempDirectory.CloseablePath` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

determineCleanupMode	back to summary
private CleanupMode determineCleanupMode(TempDir tempDir)

determineCleanupModeForField	back to summary
private CleanupMode determineCleanupModeForField(Field field)

determineCleanupModeForParameter	back to summary
private CleanupMode determineCleanupModeForParameter(ParameterContext parameterContext)

determineTempDirFactory	back to summary
private TempDirFactory determineTempDirFactory(TempDir tempDir)

determineTempDirFactoryForField	back to summary
private TempDirFactory determineTempDirFactoryForField(Field field)

determineTempDirFactoryForParameter	back to summary
private TempDirFactory determineTempDirFactoryForParameter(ParameterContext parameterContext)

getContextSpecificStore	back to summary
private static ExtensionContext.Store getContextSpecificStore(ExtensionContext context)

getPathOrFile	back to summary
private static Object getPathOrFile(Class<?> elementType, AnnotatedElementContext elementContext, TempDirFactory factory, CleanupMode cleanupMode, ExtensionContext extensionContext)

getTestInstantiationExtensionContextScope back to summary

getTestInstantiationExtensionContextScope	back to summary
public TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(ExtensionContext rootContext) Overrides default org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope. Doc from org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope. Determine whether this extension should receive a test-method scoped `ExtensionContext` during the instantiation of test classes or processing of test instances. If an extension returns `TEST_METHOD` from this method, methods defined in the following extension APIs will be called with a test-method scoped `ExtensionContext` instead of a test-class scoped context. Note, however, that a test-class scoped context will always be supplied if the `PER_CLASS` test instance lifecycle is used. `InvocationInterceptor`: only the `interceptTestClassConstructor(...)` method `ParameterResolver`: only when resolving constructor parameters `TestInstancePreConstructCallback` `TestInstancePostProcessor` `TestInstanceFactory` When a test-method scoped `ExtensionContext` is supplied, implementations of the above extension APIs will observe the following differences. `getElement()` may refer to the test method. `getTestClass()` may refer to a nested test class. For `TestInstancePostProcessor`, use `testInstance.getClass()` to get the test class associated with the supplied instance. For `TestInstanceFactory` and `TestInstancePreConstructCallback`, use `TestInstanceFactoryContext#getTestClass()` to get the class under construction. For `ParameterResolver`, when resolving a parameter for a constructor, ensure that the `Executable` is a `Constructor`, and then use `constructor.getDeclaringClass()` to get the test class associated with the constructor. `getTestMethod()` is no longer empty, unless the `PER_CLASS` test instance lifecycle is used. If the extension adds a `CloseableResource` or `AutoCloseable` to the `Store` (unless the `junit.jupiter.extensions.store.close.autocloseable.enabled` configuration parameter is set to `false`), then the resource will be closed just after the instance is destroyed. Extensions can now access data previously stored by a `TestTemplateInvocationContext`, unless the `PER_CLASS` test instance lifecycle is used. Note The behavior which is enabled by returning `TEST_METHOD` from this method will become the default in future versions of JUnit. To ensure forward compatibility, extension authors are therefore advised to opt into this feature, even if they do not require the new functionality. Annotations @Override

public TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(ExtensionContext rootContext)

Overrides default org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope.

Doc from org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope.

Determine whether this extension should receive a test-method scoped ExtensionContext during the instantiation of test classes or processing of test instances.

If an extension returns TEST_METHOD from this method, methods defined in the following extension APIs will be called with a test-method scoped ExtensionContext instead of a test-class scoped context. Note, however, that a test-class scoped context will always be supplied if the PER_CLASS test instance lifecycle is used.

InvocationInterceptor: only the interceptTestClassConstructor(...) method
ParameterResolver: only when resolving constructor parameters
TestInstancePreConstructCallback
TestInstancePostProcessor
TestInstanceFactory

When a test-method scoped ExtensionContext is supplied, implementations of the above extension APIs will observe the following differences.

getElement() may refer to the test method.
getTestClass() may refer to a nested test class.
- For TestInstancePostProcessor, use testInstance.getClass() to get the test class associated with the supplied instance.
- For TestInstanceFactory and TestInstancePreConstructCallback, use TestInstanceFactoryContext#getTestClass() to get the class under construction.
- For ParameterResolver, when resolving a parameter for a constructor, ensure that the Executable is a Constructor, and then use constructor.getDeclaringClass() to get the test class associated with the constructor.
getTestMethod() is no longer empty, unless the PER_CLASS test instance lifecycle is used.
If the extension adds a CloseableResource or AutoCloseable to the Store (unless the junit.jupiter.extensions.store.close.autocloseable.enabled configuration parameter is set to false), then the resource will be closed just after the instance is destroyed.
Extensions can now access data previously stored by a TestTemplateInvocationContext, unless the PER_CLASS test instance lifecycle is used.

Note

The behavior which is enabled by returning TEST_METHOD from this method will become the default in future versions of JUnit. To ensure forward compatibility, extension authors are therefore advised to opt into this feature, even if they do not require the new functionality.

Annotations

@Override

injectFields	back to summary
private void injectFields(ExtensionContext context, @Nullable Object testInstance, Class<?> testClass, Predicate<Field> predicate)

injectInstanceFields	back to summary
private void injectInstanceFields(ExtensionContext context, Object instance)

injectStaticFields	back to summary
private void injectStaticFields(ExtensionContext context, Class<?> testClass)

installFailureTracker	back to summary
private static void installFailureTracker(ExtensionContext context)

installFailureTracker	back to summary
private static void installFailureTracker(ExtensionContext context, ExtensionContext parentContext)

resolveParameter back to summary

resolveParameter	back to summary
public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Implements org.junit.jupiter.api.extension.ParameterResolver.resolveParameter. Resolve the current temporary directory for the `Parameter` in the supplied `ParameterContext`. Annotations @Override

public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)

Implements org.junit.jupiter.api.extension.ParameterResolver.resolveParameter.

Resolve the current temporary directory for the Parameter in the supplied ParameterContext.

Annotations

@Override

selfOrChildFailed	back to summary
private static boolean selfOrChildFailed(ExtensionContext context)

supportsParameter back to summary

supportsParameter	back to summary
public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Implements org.junit.jupiter.api.extension.ParameterResolver.supportsParameter. Determine if the `Parameter` in the supplied `ParameterContext` is annotated with `@TempDir`. Annotations @Override

public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)

Implements org.junit.jupiter.api.extension.ParameterResolver.supportsParameter.

Determine if the Parameter in the supplied ParameterContext is annotated with @TempDir.

Annotations

@Override

org.junit.jupiter.engine.extension back to summary

pack-priv Class TempDirectory.CloseablePath

Class Inheritance

extends Object
implements CloseableResource, AutoCloseable

java.lang.Object
org.junit.jupiter.engine.extension.TempDirectory.CloseablePath

All Implemented Interfaces

java.lang.AutoCloseable, org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

Annotations

@SuppressWarnings:deprecation

References Deprecated

ExtensionContext.Store.CloseableResource is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Field Summary

Modifier and Type	Field and Description
private final AnnotatedElement	annotatedElement
private final CleanupMode	cleanupMode
private final Path	dir
private final ExtensionContext	extensionContext
private final TempDirFactory	factory
private static final Logger	LOGGER

Constructor Summary

Access	Constructor and Description
private	CloseablePath(TempDirFactory factory, CleanupMode cleanupMode, Class<?> elementType, AnnotatedElementContext elementContext, ExtensionContext extensionContext)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close, java.lang.AutoCloseable.close. Close underlying resources.
private IOException	createIOExceptionWithAttachedFailures(SortedMap<Path, IOException> failures)
private SortedMap<Path, IOException>	deleteAllFilesAndDirectories(TempDirectory.FileOperations fileOperations)
private static String	descriptionFor(AnnotatedElement annotatedElement)
private static String	descriptionFor(Executable executable)
pack-priv Path	get()
private Path	relativizeSafely(Path path)
private Path	tryToDeleteOnExit(Path path)
private static void	tryToResetPermissions(Path path)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotatedElement	back to summary
private final AnnotatedElement annotatedElement

cleanupMode	back to summary
private final CleanupMode cleanupMode

dir	back to summary
private final Path dir

extensionContext	back to summary
private final ExtensionContext extensionContext

factory	back to summary
private final TempDirFactory factory

LOGGER	back to summary
private static final Logger LOGGER

Constructor Detail

CloseablePath	back to summary
private CloseablePath(TempDirFactory factory, CleanupMode cleanupMode, Class<?> elementType, AnnotatedElementContext elementContext, ExtensionContext extensionContext) throws Exception

Method Detail

close	back to summary
public void close() throws IOException Implements org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close, java.lang.AutoCloseable.close. Doc from org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close. Close underlying resources. Annotations @Override

back to summary

public void close() throws IOException

Implements org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close, java.lang.AutoCloseable.close.

Doc from org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close.

Close underlying resources.

Annotations

@Override

createIOExceptionWithAttachedFailures	back to summary
private IOException createIOExceptionWithAttachedFailures(SortedMap<Path, IOException> failures)

deleteAllFilesAndDirectories	back to summary
private SortedMap<Path, IOException> deleteAllFilesAndDirectories(TempDirectory.FileOperations fileOperations) throws IOException

descriptionFor	back to summary
private static String descriptionFor(AnnotatedElement annotatedElement) Since 5.12

descriptionFor	back to summary
private static String descriptionFor(Executable executable) Since 5.12

get	back to summary
pack-priv Path get()

relativizeSafely	back to summary
private Path relativizeSafely(Path path)

tryToDeleteOnExit	back to summary
private Path tryToDeleteOnExit(Path path) Annotations @SuppressWarnings:EmptyCatch

tryToResetPermissions	back to summary
private static void tryToResetPermissions(Path path) Annotations @SuppressWarnings:ResultOfMethodCallIgnored

org.junit.jupiter.engine.extension back to summary

private final Record TempDirectory.FailureTracker

Class Inheritance

extends Record
implements CloseableResource, AutoCloseable

java.lang.Object
java.lang.Record
org.junit.jupiter.engine.extension.TempDirectory.FailureTracker

All Implemented Interfaces

java.lang.AutoCloseable, org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

Annotations

@SuppressWarnings:deprecation

Record Components

context:ExtensionContext
parentContext:ExtensionContext

References Deprecated

ExtensionContext.Store.CloseableResource is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Field Summary

Modifier and Type	Field and Description
private final ExtensionContext	context Record Component accessed by context().
private final ExtensionContext	parentContext Record Component accessed by parentContext().

Constructor Summary

Access	Constructor and Description
private	FailureTracker(ExtensionContext context, ExtensionContext parentContext)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close, java.lang.AutoCloseable.close. Close underlying resources.
public ExtensionContext	context() Record Component getter of context.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public ExtensionContext	parentContext() Record Component getter of parentContext.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

context	back to summary
private final ExtensionContext context Record Component accessed by context().

parentContext	back to summary
private final ExtensionContext parentContext Record Component accessed by parentContext().

Constructor Detail

FailureTracker	back to summary
private FailureTracker(ExtensionContext context, ExtensionContext parentContext)

Method Detail

back to summary

public void close()

Implements org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close, java.lang.AutoCloseable.close.

Doc from org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource.close.

Close underlying resources.

Annotations

@Override

context	back to summary
public ExtensionContext context() Record Component getter of context.

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

parentContext	back to summary
public ExtensionContext parentContext() Record Component getter of parentContext.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

org.junit.jupiter.engine.extension back to summary

private final Record TempDirectory.FieldContext

Class Inheritance

extends Record
implements AnnotatedElementContext

java.lang.Object
java.lang.Record
org.junit.jupiter.engine.extension.TempDirectory.FieldContext

All Implemented Interfaces

org.junit.jupiter.api.extension.AnnotatedElementContext

Record Components

field:Field

Field Summary

Modifier and Type	Field and Description
private final Field	field Record Component accessed by field().

Constructor Summary

Access	Constructor and Description
private	FieldContext(Field field)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public Field	field() Record Component getter of field.
public AnnotatedElement	getAnnotatedElement() Implements org.junit.jupiter.api.extension.AnnotatedElementContext.getAnnotatedElement. Get the `AnnotatedElement` for this context.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

field	back to summary
private final Field field Record Component accessed by field().

Constructor Detail

FieldContext	back to summary
private FieldContext(Field field)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

field	back to summary
public Field field() Record Component getter of field.

getAnnotatedElement back to summary

public AnnotatedElement getAnnotatedElement()

Implements org.junit.jupiter.api.extension.AnnotatedElementContext.getAnnotatedElement.

Doc from org.junit.jupiter.api.extension.AnnotatedElementContext.getAnnotatedElement.

Get the AnnotatedElement for this context.

WARNING

When searching for annotations on the annotated element in this context, favor isAnnotated(Class), findAnnotation(Class), and findRepeatableAnnotations(Class) over methods in the AnnotatedElement API due to a bug in javac on JDK versions prior to JDK 9.

Annotations

@Override

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

toString back to summary

public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Annotations

@Override

pack-priv Class TempDirectory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class TempDirectory.CloseablePath

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record TempDirectory.FailureTracker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record TempDirectory.FieldContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

WARNING

pack-priv Interface TempDirectory.FileOperations

Field Summary

Method Summary

Field Detail

Method Detail