Module org.junit.jupiter.api

Package org.junit.jupiter.api.io

Enum Class CleanupMode

java.lang.Object

java.lang.Enum<CleanupMode>

org.junit.jupiter.api.io.CleanupMode

All Implemented Interfaces:

Serializable, Comparable<CleanupMode>, java.lang.constant.Constable

@API(status=EXPERIMENTAL,
     since="5.9")
public enum CleanupMode
extends Enum<CleanupMode>

Enumeration of cleanup modes for @TempDir.

When a test with a temporary directory completes, it might be useful in some cases to be able to view the contents of the temporary directory used by the test. CleanupMode allows you to control how a TempDir is cleaned up.

Since:

5.9

See Also:

• TempDir

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always clean up a temporary directory after the test has completed.
DEFAULT	Use the default cleanup mode.
NEVER	Never clean up a temporary directory after the test has completed.
ON_SUCCESS	Only clean up a temporary directory if the test completed successfully.

Method Summary

Modifier and Type	Method	Description
static CleanupMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CleanupMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final CleanupMode DEFAULT

Use the default cleanup mode.

See Also:

• TempDir.DEFAULT_CLEANUP_MODE_PROPERTY_NAME

ALWAYS

public static final CleanupMode ALWAYS

Always clean up a temporary directory after the test has completed.

ON_SUCCESS

public static final CleanupMode ON_SUCCESS

Only clean up a temporary directory if the test completed successfully.

NEVER

public static final CleanupMode NEVER

Never clean up a temporary directory after the test has completed.

Method Details

values

public static CleanupMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CleanupMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null