JUnit 6.0.1 · org.junit.jupiter.api.extension.ConditionEvaluationResult

Modifier and Type	Field and Description
private final boolean	enabled
private final Optional<String>	reason

Access	Constructor and Description
private	ConditionEvaluationResult(boolean enabled, @Nullable String reason)

Method Summary

Modifier and Type	Method and Description
public static ConditionEvaluationResult	Returns: a disabled `ConditionEvaluationResult` with the given reason or an empty reason if the reason is unknown disabled(@Nullable String the reason why the container or test should be disabled; may be `null` or blank if the reason is unknown reason) Factory for creating disabled results.
public static ConditionEvaluationResult	Returns: a disabled `ConditionEvaluationResult` with the given reason(s) or an empty reason if the reasons are unknown disabled(@Nullable String the default reason why the container or test should be disabled; may be `null` or blank if the default reason is unknown reason, @Nullable String the custom reason why the container or test should be disabled; may be `null` or blank if the custom reason is unknown customReason) Factory for creating disabled results with custom reasons added by the user.
public static ConditionEvaluationResult	Returns: an enabled `ConditionEvaluationResult` with the given reason or an empty reason if the reason is unknown enabled(@Nullable String the reason why the container or test should be enabled; may be `null` or blank if the reason is unknown reason) Factory for creating enabled results.
public Optional<String>	getReason() Get the reason why the container or test should be enabled or disabled, if available.
public boolean	Returns: `true` if the container or test should be disabled isDisabled() Whether the container or test should be disabled.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

enabled	back to summary
private final boolean enabled

reason	back to summary
private final Optional<String> reason

ConditionEvaluationResult	back to summary
private ConditionEvaluationResult(boolean enabled, @Nullable String reason)

Method Detail

disabled back to summary

disabled	back to summary
public static ConditionEvaluationResult disabled(@Nullable String reason) Factory for creating disabled results. Parameters reason:@Nullable String the reason why the container or test should be disabled; may be `null` or blank if the reason is unknown Returns:ConditionEvaluationResult a disabled `ConditionEvaluationResult` with the given reason or an empty reason if the reason is unknown See Also `StringUtils#isBlank(String)`

public static ConditionEvaluationResult disabled(@Nullable String reason)

Factory for creating disabled results.

Parameters

reason:@Nullable String: the reason why the container or test should be disabled; may be null or blank if the reason is unknown

Returns:ConditionEvaluationResult

a disabled ConditionEvaluationResult with the given reason or an empty reason if the reason is unknown

See Also

StringUtils#isBlank(String)

disabled back to summary

disabled	back to summary
public static ConditionEvaluationResult disabled(@Nullable String reason, @Nullable String customReason) Factory for creating disabled results with custom reasons added by the user. If non-blank default and custom reasons are provided, they will be concatenated using the format: `"reason ==> customReason"`. Parameters reason:@Nullable String the default reason why the container or test should be disabled; may be `null` or blank if the default reason is unknown customReason:@Nullable String the custom reason why the container or test should be disabled; may be `null` or blank if the custom reason is unknown Returns:ConditionEvaluationResult a disabled `ConditionEvaluationResult` with the given reason(s) or an empty reason if the reasons are unknown Annotations @API status:STABLE since:5.7 Since 5.7 See Also `StringUtils#isBlank(String)`

public static ConditionEvaluationResult disabled(@Nullable String reason, @Nullable String customReason)

Factory for creating disabled results with custom reasons added by the user.

If non-blank default and custom reasons are provided, they will be concatenated using the format: "reason ==> customReason".

Parameters

reason:@Nullable String: the default reason why the container or test should be disabled; may be null or blank if the default reason is unknown
customReason:@Nullable String: the custom reason why the container or test should be disabled; may be null or blank if the custom reason is unknown

Returns:ConditionEvaluationResult

a disabled ConditionEvaluationResult with the given reason(s) or an empty reason if the reasons are unknown

Annotations

@API
status:STABLE
since:5.7

Since

5.7

See Also

StringUtils#isBlank(String)

enabled back to summary

enabled	back to summary
public static ConditionEvaluationResult enabled(@Nullable String reason) Factory for creating enabled results. Parameters reason:@Nullable String the reason why the container or test should be enabled; may be `null` or blank if the reason is unknown Returns:ConditionEvaluationResult an enabled `ConditionEvaluationResult` with the given reason or an empty reason if the reason is unknown See Also `StringUtils#isBlank(String)`

public static ConditionEvaluationResult enabled(@Nullable String reason)

Factory for creating enabled results.

Parameters

reason:@Nullable String: the reason why the container or test should be enabled; may be null or blank if the reason is unknown

Returns:ConditionEvaluationResult

an enabled ConditionEvaluationResult with the given reason or an empty reason if the reason is unknown

See Also

StringUtils#isBlank(String)

getReason	back to summary
public Optional<String> getReason() Get the reason why the container or test should be enabled or disabled, if available.

isDisabled back to summary

isDisabled	back to summary
public boolean isDisabled() Whether the container or test should be disabled. Returns:boolean `true` if the container or test should be disabled

public boolean isDisabled()

Whether the container or test should be disabled.

Returns:boolean: true if the container or test should be disabled

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class ConditionEvaluationResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail