Interface TempDirDeletionStrategy

All Known Implementing Classes:

TempDirDeletionStrategy.IgnoreFailures, TempDirDeletionStrategy.Standard

@API(status=EXPERIMENTAL,
     since="6.1")
public interface TempDirDeletionStrategy

TempDirDeletionStrategy defines the SPI for deleting temporary directories programmatically.

A deletion strategy controls how a temporary directory is cleaned up when the end of its scope is reached.

Implementations must provide a no-args constructor.

A TempDirDeletionStrategy can be configured globally for the entire test suite via the "junit.jupiter.tempdir.deletion.strategy.default" configuration parameter (see the User Guide for details) or locally for a test class field or method parameter via the @TempDir annotation.

Since:

6.1

See Also:

• @TempDir

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TempDirDeletionStrategy.DeletionException	Exception thrown when one or more paths in a temporary directory could not be deleted by a TempDirDeletionStrategy.
static interface	TempDirDeletionStrategy.DeletionFailure	Represents a single failure that occurred while attempting to delete a path during a delete(Path, AnnotatedElementContext, ExtensionContext) operation.
static interface	TempDirDeletionStrategy.DeletionResult	Represents the result of a delete(Path, AnnotatedElementContext, ExtensionContext) operation, including any paths that could not be deleted.
static final class	TempDirDeletionStrategy.IgnoreFailures	A TempDirDeletionStrategy that delegates to TempDirDeletionStrategy.Standard but suppresses deletion failures by logging a warning instead of propagating them.
static final class	TempDirDeletionStrategy.Standard	Standard TempDirDeletionStrategy implementation that recursively deletes all files and directories within the temporary directory.

Method Summary

Modifier and Type	Method	Description
TempDirDeletionStrategy.DeletionResult	delete(Path tempDir, AnnotatedElementContext elementContext, ExtensionContext extensionContext)	Delete the supplied temporary directory and all of its contents.

Method Details

delete

TempDirDeletionStrategy.DeletionResult delete(Path tempDir,
 AnnotatedElementContext elementContext,
 ExtensionContext extensionContext)
                                       throws IOException

Delete the supplied temporary directory and all of its contents.

Depending on the used TempDirFactory, the supplied Path may or may not be associated with the default FileSystem.

Parameters:

tempDir - the temporary directory to delete; never null

elementContext - the context of the field or parameter where @TempDir is declared; never null

extensionContext - the current extension context; never null

Returns:

a TempDirDeletionStrategy.DeletionResult, potentially containing failures for Paths that could not be deleted or no failures if deletion was successful; never null

Throws:

IOException - in case of general failures