org.gradle.testing.jacoco.tasks.rules

Interface JacocoViolationRulesContainer

All Known Implementing Classes:

JacocoViolationRulesContainerImpl

public interface JacocoViolationRulesContainer

The violation rules configuration for the JacocoReport task.

Since:

3.4

Method Summary

Modifier and Type	Method and Description
java.util.List<JacocoViolationRule>	getRules() Gets all violation rules.
boolean	isFailOnViolation() Specifies whether build should fail in case of rule violations.
JacocoViolationRule	rule(org.gradle.api.Action<? super JacocoViolationRule> configureAction) Adds a violation rule.
void	setFailOnViolation(boolean ignore) Indicates whether build should fail in case of rule violation.

Method Detail

setFailOnViolation

void setFailOnViolation(boolean ignore)

Indicates whether build should fail in case of rule violation.

Parameters:

ignore - Only render violation but do not fail build

isFailOnViolation

@Input
boolean isFailOnViolation()

Specifies whether build should fail in case of rule violations. Defaults to true.

getRules

@Input
java.util.List<JacocoViolationRule> getRules()

Gets all violation rules. Defaults to an empty list.

rule

JacocoViolationRule rule(org.gradle.api.Action<? super JacocoViolationRule> configureAction)

Adds a violation rule. Any number of rules can be added.