Module org.junit.jupiter.api
Package org.junit.jupiter.api.condition

Annotation Type EnabledForJreRange

  • @Target({TYPE,METHOD})
@Retention(RUNTIME)
@Documented
@ExtendWith(org.junit.jupiter.api.condition.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.

    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, DisabledForJreRange, EnabledOnJre, DisabledOnJre, EnabledOnOs, DisabledOnOs, EnabledIfEnvironmentVariable, DisabledIfEnvironmentVariable, EnabledIfSystemProperty, DisabledIfSystemProperty, EnabledIf, DisabledIf, Disabled

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String disabledReason
      Reason to provide if the test of container ends up being 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

        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

        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

        String disabledReason
        Reason to provide if the test of container ends up being disabled.
        Default:
        ""