java.lang.Object
- org.junit.jupiter.api.support.io.TempDirectory

All Implemented Interfaces:

Extension, ParameterResolver
```
@API(status=EXPERIMENTAL,
     since="5.4")
public final class TempDirectory
extends Object
implements ParameterResolver
```
TempDirectory is a JUnit Jupiter extension to create and clean up a temporary directory.
The temporary directory is only created if a test or lifecycle method or test class constructor has a parameter annotated with @TempDir. If the parameter type is not Path or if the temporary directory could not be created, this extension will throw a ParameterResolutionException.
The scope of the temporary directory depends on where the first @TempDir annotation is encountered when executing a test class. The temporary directory will be shared by all tests in a class when the annotation is present on a parameter of a @BeforeAll method or the test class constructor. Otherwise, e.g. when only used on test or @BeforeEach or @AfterEach methods, each test will use its own temporary directory.
When the end of the scope of a temporary directory is reached, i.e. when the test method or class has finished execution, this extension will attempt to recursively delete all files and directories in the temporary directory and, finally, the temporary directory itself. In case deletion of a file or directory fails, this extension will throw an IOException that will cause the test to fail.
By default, this extension will use the default FileSystem to create temporary directories in the default location. However, you may instantiate this extension using the createInCustomDirectory(ParentDirProvider) or createInCustomDirectory(Callable)} factory methods and register it via @RegisterExtension to pass a custom provider to configure the parent directory for all temporary directories created by this extension. This allows the use of this extension with any third-party FileSystem implementation, e.g. Jimfs.

Since:

5.4

See Also:

TempDirectory.TempDir, TempDirectory.ParentDirProvider, Files.createTempDirectory(java.nio.file.Path, java.lang.String, java.nio.file.attribute.FileAttribute<?>...)

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`TempDirectory.ParentDirProvider`	`ParentDirProvider` can be used to configure a custom parent directory for all temporary directories created by the `TempDirectory` extension this is used with.
`static interface`	`TempDirectory.TempDir`	`TempDir` can be used to annotate a test or lifecycle method or test class constructor parameter of type `Path` that should be resolved into a temporary directory.

Constructor Summary

Constructors
Constructor Description

TempDirectory()
Create a new TempDirectory extension that uses the default FileSystem and creates temporary directories in the default location.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TempDirectory`	`createInCustomDirectory(Callable<Path> parentDirProvider)`	Returns a `TempDirectory` extension that uses the supplied `Callable` to configure the parent directory for the temporary directories created by this extension.
`static TempDirectory`	`createInCustomDirectory(TempDirectory.ParentDirProvider parentDirProvider)`	Create a `TempDirectory` extension that uses the supplied `TempDirectory.ParentDirProvider` to configure the parent directory for the temporary directories created by this extension.
`static TempDirectory`	`createInDefaultDirectory()`	Create a `TempDirectory` extension that uses the default `FileSystem` and creates temporary directories in the default location.
`Object`	`resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)`	Resolve an argument for the `Parameter` in the supplied `ParameterContext` for the supplied `ExtensionContext`.
`boolean`	`supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)`	Determine if this resolver supports resolution of an argument for the `Parameter` in the supplied `ParameterContext` for the supplied `ExtensionContext`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TempDirectory
```
public TempDirectory()
```
    Create a new TempDirectory extension that uses the default FileSystem and creates temporary directories in the default location.
    This constructor is used by the JUnit Jupiter Engine when the extension is registered via @ExtendWith.
- Method Detail
  - createInDefaultDirectory
```
public static TempDirectory createInDefaultDirectory()
```
    Create a TempDirectory extension that uses the default FileSystem and creates temporary directories in the default location.
    You may use this factory method when registering this extension via @RegisterExtension, although you might prefer the simpler registration via @ExtendWith.
    
    Returns:
    
    a TempDirectory extension
  - createInCustomDirectory
```
public static TempDirectory createInCustomDirectory(TempDirectory.ParentDirProvider parentDirProvider)
```
    Create a TempDirectory extension that uses the supplied TempDirectory.ParentDirProvider to configure the parent directory for the temporary directories created by this extension.
    You may use this factory method when registering this extension via @RegisterExtension.
    
    Parameters:
    
    parentDirProvider - used to configure the parent directory for the temporary directories created by this extension
    
    Returns:
    
    a TempDirectory extension
  - createInCustomDirectory
```
public static TempDirectory createInCustomDirectory(Callable<Path> parentDirProvider)
```
    Returns a TempDirectory extension that uses the supplied Callable to configure the parent directory for the temporary directories created by this extension.
    You may use this factory method when registering this extension via @RegisterExtension.
    
    Parameters:
    
    parentDirProvider - used to configure the parent directory for the temporary directories created by this extension
  - supportsParameter
```
public boolean supportsParameter(ParameterContext parameterContext,
                                 ExtensionContext extensionContext)
```
    Description copied from interface: ParameterResolver
    
    Determine if this resolver supports resolution of an argument for the Parameter in the supplied ParameterContext for the supplied ExtensionContext.
    The Method or Constructor in which the parameter is declared can be retrieved via ParameterContext.getDeclaringExecutable().
    
    Specified by:
    
    supportsParameter in interface ParameterResolver
    
    Parameters:
    
    parameterContext - the context for the parameter for which an argument should be resolved; never null
    
    extensionContext - the extension context for the Executable about to be invoked; never null
    
    Returns:
    
    true if this resolver can resolve an argument for the parameter
    
    See Also:
    
    ParameterResolver.resolveParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext), ParameterContext
  - resolveParameter
```
public Object resolveParameter(ParameterContext parameterContext,
                               ExtensionContext extensionContext)
```
    Description copied from interface: ParameterResolver
    
    Resolve an argument for the Parameter in the supplied ParameterContext for the supplied ExtensionContext.
    This method is only called by the framework if ParameterResolver.supportsParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext) previously returned true for the same ParameterContext and ExtensionContext.
    The Method or Constructor in which the parameter is declared can be retrieved via ParameterContext.getDeclaringExecutable().
    
    Specified by:
    
    resolveParameter in interface ParameterResolver
    
    Parameters:
    
    parameterContext - the context for the parameter for which an argument should be resolved; never null
    
    extensionContext - the extension context for the Executable about to be invoked; never null
    
    Returns:
    
    the resolved argument for the parameter; may only be null if the parameter type is not a primitive
    
    See Also:
    
    ParameterResolver.supportsParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext), ParameterContext

Class TempDirectory

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TempDirectory

Method Detail

createInDefaultDirectory

createInCustomDirectory

createInCustomDirectory

supportsParameter

resolveParameter