Module org.junit.jupiter.api

Package org.junit.jupiter.api

Enum Class Timeout.ThreadMode

java.lang.Object

java.lang.Enum<Timeout.ThreadMode>

org.junit.jupiter.api.Timeout.ThreadMode

All Implemented Interfaces:

Serializable, Comparable<Timeout.ThreadMode>, java.lang.constant.Constable

Enclosing class:

Timeout

@API(status=EXPERIMENTAL,
     since="5.9")
public static enum Timeout.ThreadMode
extends Enum<Timeout.ThreadMode>

ThreadMode is use to define whether the test code should be executed in the thread of the calling code or in a separated thread.

Since:

5.9

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
INFERRED	The thread mode is determined using the parameter configured in property "junit.jupiter.execution.timeout.thread.mode.default".
SAME_THREAD	The test code is executed in the thread of the calling code.
SEPARATE_THREAD	The test code is executed in a different thread than that of the calling code.

Method Summary

Modifier and Type	Method	Description
static Timeout.ThreadMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Timeout.ThreadMode[]	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

INFERRED

public static final Timeout.ThreadMode INFERRED

The thread mode is determined using the parameter configured in property "junit.jupiter.execution.timeout.thread.mode.default".

SAME_THREAD

public static final Timeout.ThreadMode SAME_THREAD

The test code is executed in the thread of the calling code.

SEPARATE_THREAD

public static final Timeout.ThreadMode SEPARATE_THREAD

The test code is executed in a different thread than that of the calling code. Furthermore, execution of the test code will be preemptively aborted if the timeout is exceeded. See the Preemptive Timeouts section of the class-level Javadoc for a discussion of possible undesirable side effects.

Method Details

values

public static Timeout.ThreadMode[] 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 Timeout.ThreadMode 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