Package org.junit.jupiter.api.extension

Enum TestInstantiationAwareExtension.ExtensionContextScope

java.lang.Object

java.lang.Enum<TestInstantiationAwareExtension.ExtensionContextScope>

org.junit.jupiter.api.extension.TestInstantiationAwareExtension.ExtensionContextScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TestInstantiationAwareExtension.ExtensionContextScope>

Enclosing interface:

TestInstantiationAwareExtension

@API(status=MAINTAINED,
     since="5.13.3")
public static enum TestInstantiationAwareExtension.ExtensionContextScope
extends java.lang.Enum<TestInstantiationAwareExtension.ExtensionContextScope>

ExtensionContextScope is used to define the scope of the ExtensionContext supplied to an extension during the instantiation of test classes or processing of test instances.

Since:

5.12

See Also:

TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope(ExtensionContext)

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Deprecated. This behavior will be removed from future versions of JUnit, and TEST_METHOD will become the default.
TEST_METHOD	The extension should receive an ExtensionContext scoped to the test method.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_SCOPE_PROPERTY_NAME	Property name used to set the default extension context scope: "junit.jupiter.extensions.testinstantiation.extensioncontextscope.default"

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

@API(status=DEPRECATED,
     since="5.12")
@Deprecated
public static final TestInstantiationAwareExtension.ExtensionContextScope DEFAULT

Deprecated.

This behavior will be removed from future versions of JUnit, and TEST_METHOD will become the default.

The extension should receive an ExtensionContext for the the default scope.

The default scope is determined by the configuration parameter DEFAULT_SCOPE_PROPERTY_NAME. If not specified, extensions will receive an ExtensionContext scoped to the test class.

See Also:

DEFAULT_SCOPE_PROPERTY_NAME

TEST_METHOD

public static final TestInstantiationAwareExtension.ExtensionContextScope TEST_METHOD

The extension should receive an ExtensionContext scoped to the test method.

Note, however, that a test-class scoped context will always be supplied if the PER_CLASS test instance lifecycle is used.

Field Detail

DEFAULT_SCOPE_PROPERTY_NAME

public static final java.lang.String DEFAULT_SCOPE_PROPERTY_NAME

Property name used to set the default extension context scope: "junit.jupiter.extensions.testinstantiation.extensioncontextscope.default"

Supported Values

Supported values include names of enum constants defined in this class, ignoring case.

See Also:

DEFAULT, Constant Field Values

Method Detail

values

public static TestInstantiationAwareExtension.ExtensionContextScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TestInstantiationAwareExtension.ExtensionContextScope c : TestInstantiationAwareExtension.ExtensionContextScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static TestInstantiationAwareExtension.ExtensionContextScope valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null