org.junit.jupiter.api.condition

Annotation Type EnabledForJreRange

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
 @ExtendWith(value=EnabledForJreRangeCondition.class)
 @API(status=STABLE,
     since="5.6")
public @interface EnabledForJreRange

@EnabledForJreRange is used to signal that the annotated test class or test method is only enabled for a specific range of Java Runtime Environment (JRE) versions from min() to max().

When applied at the class level, all test methods within that class will be enabled on the same specified JRE versions.

This annotation is not @Inherited. Consequently, if you wish to apply the same semantics to a subclass, this annotation must be redeclared on the subclass.

If a test method is disabled via this annotation, that does not prevent the test class from being instantiated. Rather, it prevents the execution of the test method and method-level lifecycle callbacks such as @BeforeEach methods, @AfterEach methods, and corresponding extension APIs.

This annotation may be used as a meta-annotation in order to create a custom composed annotation that inherits the semantics of this annotation.

Warning

This annotation can only be declared once on an AnnotatedElement (i.e., test interface, test class, or test method). If this annotation is directly present, indirectly present, or meta-present multiple times on a given element, only the first such annotation discovered by JUnit will be used; any additional declarations will be silently ignored. Note, however, that this annotation may be used in conjunction with other @Enabled* or @Disabled* annotations in this package.

Since:

5.6

See Also:

JRE, EnabledIf, DisabledIf, EnabledOnOs, DisabledOnOs, EnabledOnJre, DisabledOnJre, DisabledForJreRange, EnabledInNativeImage, DisabledInNativeImage, EnabledIfSystemProperty, DisabledIfSystemProperty, EnabledIfEnvironmentVariable, DisabledIfEnvironmentVariable, Disabled

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	disabledReason Custom reason to provide if the test or container is disabled.
JRE	max Java Runtime Environment version which should be used as the upper boundary for the version range that determines if the annotated class or method should be enabled.
JRE	min Java Runtime Environment version which should be used as the lower boundary for the version range that determines if the annotated class or method should be enabled.

Element Detail

min

public abstract JRE min

Java Runtime Environment version which should be used as the lower boundary for the version range that determines if the annotated class or method should be enabled.

Defaults to JAVA_8, as this is the lowest supported JRE version.

See Also:

JRE

Default:

org.junit.jupiter.api.condition.JRE.JAVA_8

max

public abstract JRE max

Java Runtime Environment version which should be used as the upper boundary for the version range that determines if the annotated class or method should be enabled.

Defaults to OTHER, as this will always be the highest possible version.

See Also:

JRE

Default:

org.junit.jupiter.api.condition.JRE.OTHER

disabledReason

@API(status=STABLE,
     since="5.7")
public abstract java.lang.String disabledReason

Custom reason to provide if the test or container is disabled.

If a custom reason is supplied, it will be combined with the default reason for this annotation. If a custom reason is not supplied, the default reason will be used.

Since:

5.7

Default:

""