Top Description Fields Constructors Methods
org.junit.jupiter.engine

public final Class Constants

extends Object
Class Inheritance
Annotations
@API
status:STABLE
since:5.0
Static Imports
org.apiguardian.api.API.Status.EXPERIMENTAL, .API.Status.MAINTAINED, .API.Status.STABLE, org.junit.platform.engine.support.hierarchical.DefaultParallelExecutionConfigurationStrategy.CONFIG_CUSTOM_CLASS_PROPERTY_NAME, .DefaultParallelExecutionConfigurationStrategy.CONFIG_DYNAMIC_FACTOR_PROPERTY_NAME, .DefaultParallelExecutionConfigurationStrategy.CONFIG_FIXED_MAX_POOL_SIZE_PROPERTY_NAME, .DefaultParallelExecutionConfigurationStrategy.CONFIG_FIXED_PARALLELISM_PROPERTY_NAME, .DefaultParallelExecutionConfigurationStrategy.CONFIG_FIXED_SATURATE_PROPERTY_NAME, .DefaultParallelExecutionConfigurationStrategy.CONFIG_STRATEGY_PROPERTY_NAME

Collection of constants related to the JupiterTestEngine.
Since
5.0
See Also
org.junit.platform.engine.ConfigurationParameters

Field Summary

Modifier and TypeField and Description
public static final String
CLOSING_STORED_AUTO_CLOSEABLE_ENABLED_PROPERTY_NAME

Property name used to enable auto-closing of AutoCloseable instances

By default, auto-closing is enabled.

public static final String
DEACTIVATE_ALL_CONDITIONS_PATTERN

Wildcard pattern which signals that all conditions should be deactivated:

public static final String
DEACTIVATE_CONDITIONS_PATTERN_PROPERTY_NAME

Property name used to provide patterns for deactivating conditions: Pattern Matching Syntax

If the property value consists solely of an asterisk (*), all conditions will be deactivated.

public static final String
DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @AfterAll methods: .

public static final String
DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @AfterEach methods: .

public static final String
DEFAULT_BEFORE_ALL_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @BeforeAll methods: .

public static final String
DEFAULT_BEFORE_EACH_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @BeforeEach methods: .

public static final String
DEFAULT_CLASSES_EXECUTION_MODE_PROPERTY_NAME

Property name used to set the default test execution mode for top-level classes:

public static final String
DEFAULT_DISPLAY_NAME_GENERATOR_PROPERTY_NAME

Property name used to set the default display name generator class name:

public static final String
DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all lifecycle methods: .

public static final String
DEFAULT_PARALLEL_EXECUTION_MODE

Property name used to set the default test execution mode:

public static final String
DEFAULT_TEMP_DIR_FACTORY_PROPERTY_NAME

Property name used to set the default factory for temporary directories created via the @TempDir annotation:

public static final String
DEFAULT_TEST_CLASS_INSTANCE_CONSTRUCTION_EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME

Property name used to set the default extension context scope for extensions that participate in test instantiation:

public static final String
DEFAULT_TEST_CLASS_ORDER_PROPERTY_NAME

Property name used to set the default class orderer class name:

public static final String
DEFAULT_TEST_FACTORY_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @TestFactory methods: .

public static final String
DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME

Property name used to set the default test instance lifecycle mode:

public static final String
DEFAULT_TEST_METHOD_ORDER_PROPERTY_NAME

Property name used to set the default method orderer class name:

public static final String
DEFAULT_TEST_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @Test methods: .

public static final String
DEFAULT_TEST_TEMPLATE_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @TestTemplate methods: .

public static final String
DEFAULT_TESTABLE_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all testable methods: .

public static final String
DEFAULT_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all testable and lifecycle methods: .

public static final String
DEFAULT_TIMEOUT_THREAD_MODE_PROPERTY_NAME

Property name used to set the default timeout thread mode.

public static final String
EXTENSIONS_AUTODETECTION_ENABLED_PROPERTY_NAME

Property name used to enable auto-detection and registration of extensions via Java's java.util.ServiceLoader mechanism:

The default behavior is not to perform auto-detection.

public static final String
EXTENSIONS_AUTODETECTION_EXCLUDE_PROPERTY_NAME

Property name used to exclude patterns for auto-detecting extensions: Pattern Matching Syntax

If the property value consists solely of an asterisk (*), all extensions will be excluded.

public static final String
EXTENSIONS_AUTODETECTION_INCLUDE_PROPERTY_NAME

Property name used to include patterns for auto-detecting extensions: Pattern Matching Syntax

If the property value consists solely of an asterisk (*), all extensions will be included.

public static final String
EXTENSIONS_TIMEOUT_THREAD_DUMP_ENABLED_PROPERTY_NAME

Property name used to enable dumping the stack of all threads to System.out when a timeout has occurred.

public static final String
PARALLEL_CONFIG_CUSTOM_CLASS_PROPERTY_NAME

Property name used to specify the fully qualified class name of the ParallelExecutionConfigurationStrategy to be used for the custom configuration strategy:

public static final String
PARALLEL_CONFIG_DYNAMIC_FACTOR_PROPERTY_NAME

Property name used to set the factor to be multiplied with the number of available processors/cores to determine the desired parallelism for the dynamic configuration strategy:

Value must be a positive decimal number; defaults to 1.

public static final String
PARALLEL_CONFIG_FIXED_MAX_POOL_SIZE_PROPERTY_NAME

Property name used to configure the maximum pool size of the underlying fork-join pool for the fixed configuration strategy:

Value must be an integer and greater than or equal to junit.jupiter.execution.parallel.config.fixed.parallelism; defaults to 256 + fixed.parallelism.

public static final String
PARALLEL_CONFIG_FIXED_PARALLELISM_PROPERTY_NAME

Property name used to set the desired parallelism for the fixed configuration strategy:

No default value; must be a positive integer.

public static final String
PARALLEL_CONFIG_FIXED_SATURATE_PROPERTY_NAME

Property name used to disable saturation of the underlying fork-join pool for the fixed configuration strategy:

When set to false the underlying fork-join pool will reject additional tasks if all available workers are busy and the maximum pool-size would be exceeded.

pack-priv static final String
public static final String
PARALLEL_CONFIG_STRATEGY_PROPERTY_NAME

Property name used to select the ParallelExecutionConfigurationStrategy:

Potential values: dynamic (default), fixed, or custom.

public static final String
PARALLEL_EXECUTION_ENABLED_PROPERTY_NAME

Property name used to enable parallel test execution:

By default, tests are executed sequentially in a single thread.

public static final String
TIMEOUT_MODE_PROPERTY_NAME

Property name used to configure whether timeouts are applied to tests: .

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CLOSING_STORED_AUTO_CLOSEABLE_ENABLED_PROPERTY_NAMEback to summary
public static final String CLOSING_STORED_AUTO_CLOSEABLE_ENABLED_PROPERTY_NAME

Property name used to enable auto-closing of AutoCloseable instances

By default, auto-closing is enabled.

Annotations
@API
status:EXPERIMENTAL
since:6.0
Since
5.13
DEACTIVATE_ALL_CONDITIONS_PATTERNback to summary
public static final String DEACTIVATE_ALL_CONDITIONS_PATTERN

Wildcard pattern which signals that all conditions should be deactivated:

See Also
DEACTIVATE_CONDITIONS_PATTERN_PROPERTY_NAME, org.junit.jupiter.api.extension.ExecutionCondition
DEACTIVATE_CONDITIONS_PATTERN_PROPERTY_NAMEback to summary
public static final String DEACTIVATE_CONDITIONS_PATTERN_PROPERTY_NAME

Property name used to provide patterns for deactivating conditions:

Pattern Matching Syntax

If the property value consists solely of an asterisk (*), all conditions will be deactivated. Otherwise, the property value will be treated as a comma-separated list of patterns where each individual pattern will be matched against the fully qualified class name (FQCN) of each registered condition. Any dot (.) in a pattern will match against a dot (.) or a dollar sign ($) in a FQCN. Any asterisk (*) will match against one or more characters in a FQCN. All other characters in a pattern will be matched one-to-one against a FQCN.

Examples

  • *: deactivates all conditions.
  • org.junit.*: deactivates every condition under the org.junit base package and any of its subpackages.
  • *.MyCondition: deactivates every condition whose simple class name is exactly MyCondition.
  • *System*: deactivates every condition whose FQCN contains System.
  • *System*, *Dev*: deactivates every condition whose FQCN contains System or Dev.
  • org.example.MyCondition, org.example.TheirCondition: deactivates conditions whose FQCN is exactly org.example.MyCondition or org.example.TheirCondition.
See Also
DEACTIVATE_ALL_CONDITIONS_PATTERN, org.junit.jupiter.api.extension.ExecutionCondition
DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @AfterAll methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_AFTER_ALL_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @AfterEach methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_AFTER_EACH_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_BEFORE_ALL_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_BEFORE_ALL_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @BeforeAll methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_BEFORE_ALL_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_BEFORE_EACH_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_BEFORE_EACH_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @BeforeEach methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_BEFORE_EACH_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_CLASSES_EXECUTION_MODE_PROPERTY_NAMEback to summary
public static final String DEFAULT_CLASSES_EXECUTION_MODE_PROPERTY_NAME

Property name used to set the default test execution mode for top-level classes:

Annotations
@API
status:STABLE
since:5.10
See Also
Execution#DEFAULT_CLASSES_EXECUTION_MODE_PROPERTY_NAME
DEFAULT_DISPLAY_NAME_GENERATOR_PROPERTY_NAMEback to summary
public static final String DEFAULT_DISPLAY_NAME_GENERATOR_PROPERTY_NAME

Property name used to set the default display name generator class name:

See Also
DisplayNameGenerator#DEFAULT_GENERATOR_PROPERTY_NAME
DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all lifecycle methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_LIFECYCLE_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_PARALLEL_EXECUTION_MODEback to summary
public static final String DEFAULT_PARALLEL_EXECUTION_MODE

Property name used to set the default test execution mode:

Annotations
@API
status:STABLE
since:5.10
See Also
Execution#DEFAULT_EXECUTION_MODE_PROPERTY_NAME
DEFAULT_TEMP_DIR_FACTORY_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEMP_DIR_FACTORY_PROPERTY_NAME

Property name used to set the default factory for temporary directories created via the @TempDir annotation:

Annotations
@API
status:MAINTAINED
since:5.13.3
Since
5.10
See Also
TempDir#DEFAULT_FACTORY_PROPERTY_NAME
DEFAULT_TEST_CLASS_INSTANCE_CONSTRUCTION_EXTENSION_CONTEXT_SCOPE_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_CLASS_INSTANCE_CONSTRUCTION_EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME

Property name used to set the default extension context scope for extensions that participate in test instantiation:

Annotations
@API
status:MAINTAINED
since:5.13.3
Since
5.12
See Also
org.junit.jupiter.api.extension.TestInstantiationAwareExtension
DEFAULT_TEST_CLASS_ORDER_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_CLASS_ORDER_PROPERTY_NAME

Property name used to set the default class orderer class name:

Annotations
@API
status:STABLE
since:5.9
See Also
ClassOrderer#DEFAULT_ORDER_PROPERTY_NAME
DEFAULT_TEST_FACTORY_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_FACTORY_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @TestFactory methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_TEST_FACTORY_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_INSTANCE_LIFECYCLE_PROPERTY_NAME

Property name used to set the default test instance lifecycle mode:

See Also
TestInstance.Lifecycle#DEFAULT_LIFECYCLE_PROPERTY_NAME
DEFAULT_TEST_METHOD_ORDER_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_METHOD_ORDER_PROPERTY_NAME

Property name used to set the default method orderer class name:

Annotations
@API
status:STABLE
since:5.9
See Also
MethodOrderer#DEFAULT_ORDER_PROPERTY_NAME
DEFAULT_TEST_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @Test methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_TEST_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_TEST_TEMPLATE_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_TEST_TEMPLATE_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all @TestTemplate methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_TEST_TEMPLATE_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_TESTABLE_METHOD_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_TESTABLE_METHOD_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all testable methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_TESTABLE_METHOD_TIMEOUT_PROPERTY_NAME
DEFAULT_TIMEOUT_PROPERTY_NAMEback to summary
public static final String DEFAULT_TIMEOUT_PROPERTY_NAME

Property name used to set the default timeout for all testable and lifecycle methods: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#DEFAULT_TIMEOUT_PROPERTY_NAME
DEFAULT_TIMEOUT_THREAD_MODE_PROPERTY_NAMEback to summary
public static final String DEFAULT_TIMEOUT_THREAD_MODE_PROPERTY_NAME

Property name used to set the default timeout thread mode.

Annotations
@API
status:MAINTAINED
since:5.13.3
Since
5.9
See Also
Timeout, Timeout.ThreadMode
EXTENSIONS_AUTODETECTION_ENABLED_PROPERTY_NAMEback to summary
public static final String EXTENSIONS_AUTODETECTION_ENABLED_PROPERTY_NAME

Property name used to enable auto-detection and registration of extensions via Java's java.util.ServiceLoader mechanism:

The default behavior is not to perform auto-detection.

EXTENSIONS_AUTODETECTION_EXCLUDE_PROPERTY_NAMEback to summary
public static final String EXTENSIONS_AUTODETECTION_EXCLUDE_PROPERTY_NAME

Property name used to exclude patterns for auto-detecting extensions:

Pattern Matching Syntax

If the property value consists solely of an asterisk (*), all extensions will be excluded. Otherwise, the property value will be treated as a comma-separated list of patterns where each individual pattern will be matched against the fully qualified class name (FQCN) of each extension. Any dot (.) in a pattern will match against a dot (.) or a dollar sign ($) in a FQCN. Any asterisk (*) will match against one or more characters in a FQCN. All other characters in a pattern will be matched one-to-one against a FQCN.

Examples

  • *: excludes all extensions.
  • org.junit.*: excludes every extension under the org.junit base package and any of its subpackages.
  • *.MyExtension: excludes every extension whose simple class name is exactly MyExtension.
  • *System*: excludes every extension whose FQCN contains System.
  • *System*, *Dev*: excludes every extension whose FQCN contains System or Dev.
  • org.example.MyExtension, org.example.TheirExtension: excludes extensions whose FQCN is exactly org.example.MyExtension or org.example.TheirExtension.

Note

A class that matches both an inclusion and exclusion pattern will be excluded.

See Also
JupiterConfiguration#EXTENSIONS_AUTODETECTION_EXCLUDE_PROPERTY_NAME
EXTENSIONS_AUTODETECTION_INCLUDE_PROPERTY_NAMEback to summary
public static final String EXTENSIONS_AUTODETECTION_INCLUDE_PROPERTY_NAME

Property name used to include patterns for auto-detecting extensions:

Pattern Matching Syntax

If the property value consists solely of an asterisk (*), all extensions will be included. Otherwise, the property value will be treated as a comma-separated list of patterns where each individual pattern will be matched against the fully qualified class name (FQCN) of each extension. Any dot (.) in a pattern will match against a dot (.) or a dollar sign ($) in a FQCN. Any asterisk (*) will match against one or more characters in a FQCN. All other characters in a pattern will be matched one-to-one against a FQCN.

Examples

  • *: includes all extensions.
  • org.junit.*: includes every extension under the org.junit base package and any of its subpackages.
  • *.MyExtension: includes every extension whose simple class name is exactly MyExtension.
  • *System*: includes every extension whose FQCN contains System.
  • *System*, *Dev*: includes every extension whose FQCN contains System or Dev.
  • org.example.MyExtension, org.example.TheirExtension: includes extensions whose FQCN is exactly org.example.MyExtension or org.example.TheirExtension.

Note

A class that matches both an inclusion and exclusion pattern will be excluded.

See Also
JupiterConfiguration#EXTENSIONS_AUTODETECTION_INCLUDE_PROPERTY_NAME
EXTENSIONS_TIMEOUT_THREAD_DUMP_ENABLED_PROPERTY_NAMEback to summary
public static final String EXTENSIONS_TIMEOUT_THREAD_DUMP_ENABLED_PROPERTY_NAME

Property name used to enable dumping the stack of all threads to System.out when a timeout has occurred.

This behavior is disabled by default.

Annotations
@API
status:MAINTAINED
since:5.13.3
Since
5.12
PARALLEL_CONFIG_CUSTOM_CLASS_PROPERTY_NAMEback to summary
public static final String PARALLEL_CONFIG_CUSTOM_CLASS_PROPERTY_NAME

Property name used to specify the fully qualified class name of the ParallelExecutionConfigurationStrategy to be used for the custom configuration strategy:

Annotations
@API
status:STABLE
since:5.10
Since
5.3
PARALLEL_CONFIG_DYNAMIC_FACTOR_PROPERTY_NAMEback to summary
public static final String PARALLEL_CONFIG_DYNAMIC_FACTOR_PROPERTY_NAME

Property name used to set the factor to be multiplied with the number of available processors/cores to determine the desired parallelism for the dynamic configuration strategy:

Value must be a positive decimal number; defaults to 1.

Annotations
@API
status:STABLE
since:5.10
Since
5.3
PARALLEL_CONFIG_FIXED_MAX_POOL_SIZE_PROPERTY_NAMEback to summary
public static final String PARALLEL_CONFIG_FIXED_MAX_POOL_SIZE_PROPERTY_NAME

Property name used to configure the maximum pool size of the underlying fork-join pool for the fixed configuration strategy:

Value must be an integer and greater than or equal to junit.jupiter.execution.parallel.config.fixed.parallelism; defaults to 256 + fixed.parallelism.

Annotations
@API
status:MAINTAINED
since:5.13.3
Since
5.10
PARALLEL_CONFIG_FIXED_PARALLELISM_PROPERTY_NAMEback to summary
public static final String PARALLEL_CONFIG_FIXED_PARALLELISM_PROPERTY_NAME

Property name used to set the desired parallelism for the fixed configuration strategy:

No default value; must be a positive integer.

Annotations
@API
status:STABLE
since:5.10
Since
5.3
PARALLEL_CONFIG_FIXED_SATURATE_PROPERTY_NAMEback to summary
public static final String PARALLEL_CONFIG_FIXED_SATURATE_PROPERTY_NAME

Property name used to disable saturation of the underlying fork-join pool for the fixed configuration strategy:

When set to false the underlying fork-join pool will reject additional tasks if all available workers are busy and the maximum pool-size would be exceeded.

Value must either true or false; defaults to true.

Annotations
@API
status:MAINTAINED
since:5.13.3
Since
5.10
PARALLEL_CONFIG_PREFIXback to summary
pack-priv static final String PARALLEL_CONFIG_PREFIX
PARALLEL_CONFIG_STRATEGY_PROPERTY_NAMEback to summary
public static final String PARALLEL_CONFIG_STRATEGY_PROPERTY_NAME

Property name used to select the ParallelExecutionConfigurationStrategy:

Potential values: dynamic (default), fixed, or custom.

Annotations
@API
status:STABLE
since:5.10
Since
5.3
PARALLEL_EXECUTION_ENABLED_PROPERTY_NAMEback to summary
public static final String PARALLEL_EXECUTION_ENABLED_PROPERTY_NAME

Property name used to enable parallel test execution:

By default, tests are executed sequentially in a single thread.

Annotations
@API
status:STABLE
since:5.10
Since
5.3
TIMEOUT_MODE_PROPERTY_NAMEback to summary
public static final String TIMEOUT_MODE_PROPERTY_NAME

Property name used to configure whether timeouts are applied to tests: .

Annotations
@API
status:STABLE
since:5.10
See Also
Timeout#TIMEOUT_MODE_PROPERTY_NAME

Constructor Detail

Constantsback to summary
private Constants()