Interface TempDirDeletionStrategy.DeletionResult

Enclosing interface:

TempDirDeletionStrategy

public static sealed interface TempDirDeletionStrategy.DeletionResult

Represents the result of a TempDirDeletionStrategy.delete(Path, AnnotatedElementContext, ExtensionContext) operation, including any paths that could not be deleted.

Since:

6.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TempDirDeletionStrategy.DeletionResult.Builder	Builder for TempDirDeletionStrategy.DeletionResult.

Method Summary

Modifier and Type	Method	Description
static TempDirDeletionStrategy.DeletionResult.Builder	builder(Path rootDir)	Create a new TempDirDeletionStrategy.DeletionResult.Builder for the supplied root directory.
List<TempDirDeletionStrategy.DeletionFailure>	failures()	Return the list of failures that occurred during deletion.
default boolean	isSuccessful()	Return true if the deletion was successful, i.e., no failures were recorded.
Path	rootDir()	Return the root temporary directory of this deletion operation.
Optional<TempDirDeletionStrategy.DeletionException>	toException()	Convert this result to a TempDirDeletionStrategy.DeletionException summarizing all failures.

Method Details

builder

static TempDirDeletionStrategy.DeletionResult.Builder builder(Path rootDir)

Create a new TempDirDeletionStrategy.DeletionResult.Builder for the supplied root directory.

Parameters:

rootDir - the root temporary directory; never null

Returns:

a new Builder; never null

rootDir

Path rootDir()

Return the root temporary directory of this deletion operation.

Returns:

the root directory; never null

failures

List<TempDirDeletionStrategy.DeletionFailure> failures()

Return the list of failures that occurred during deletion.

Returns:

the list of failures; never null

isSuccessful

default boolean isSuccessful()

Return true if the deletion was successful, i.e., no failures were recorded.

toException

Optional<TempDirDeletionStrategy.DeletionException> toException()

Convert this result to a TempDirDeletionStrategy.DeletionException summarizing all failures.

Must only be called if isSuccessful() returns false.

Returns:

an TempDirDeletionStrategy.DeletionException, if the deletion was successful; otherwise, empty; never null