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

Annotation Interface EnabledOnJre

@Target({TYPE,METHOD}) @Retention(RUNTIME) @Documented @ExtendWith(org.junit.jupiter.api.condition.EnabledOnJreCondition.class) @API(status=STABLE, since="5.1") public @interface EnabledOnJre
@EnabledOnJre is used to signal that the annotated test class or test method is only enabled on one or more specified Java Runtime Environment (JRE) versions.

Versions can be specified as JRE enum constants via value or as integers via versions.

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 prevents execution of the test method and method-level lifecycle callbacks such as @BeforeEach methods, @AfterEach methods, and corresponding extension APIs. However, that does not prevent the test class from being instantiated, and it does not prevent the execution of class-level lifecycle callbacks such as @BeforeAll methods, @AfterAll 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

As of JUnit Jupiter 5.1, 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.1
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    disabledReason
    Custom reason to provide if the test or container is disabled.
    JRE[]
    value
    Java Runtime Environment versions on which the annotated class or method should be enabled, specified as JRE enum constants.
    int[]
    versions
    Java Runtime Environment versions on which the annotated class or method should be enabled, specified as integers.

  • Element Details

    • value

      JRE[] value
      Java Runtime Environment versions on which the annotated class or method should be enabled, specified as JRE enum constants.

      If a JRE enum constant does not exist for a particular JRE version, you can specify the version via versions instead.

      See Also:
      Default:
      {}

    • versions

      @API(status=EXPERIMENTAL, since="5.12") int[] versions
      Java Runtime Environment versions on which the annotated class or method should be enabled, specified as integers.

      If a JRE enum constant exists for a particular JRE version, you can specify the version via value instead.

      Since:
      5.12
      See Also:
      Default:
      {}

    • disabledReason

      @API(status=STABLE, since="5.7") 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:
      ""