Annotation Interface DisabledIf
@DisabledIfis used to signal that the annotated test class or test method is disabled only if the provided condition evaluates to
When applied at the class level, all test methods within that class will be disabled on the same condition.
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
@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.
WarningThis 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
@Disabled*annotations in this package.
Required Element SummaryModifier and TypeRequired ElementDescriptionThe name of a method within the test class or in external classes to use as a condition for the container's execution.
Optional Element SummaryModifier and TypeOptional ElementDescriptionCustom reason to provide if the test or container is disabled.
valueString valueThe name of a method within the test class or in external classes to use as a condition for the container's execution.
Condition methods must be static if located outside the test class, or if
@DisabledIfis used at class level.
Condition methods in external classes must be referenced by fully qualified method name — for example,
disabledReasonString disabledReasonCustom 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.