api / org.gradle.testing.jacoco.tasks.rules / JacocoViolationRulesContainer

JacocoViolationRulesContainer

@Incubating interface JacocoViolationRulesContainer

The violation rules configuration for the org.gradle.testing.jacoco.tasks.JacocoReport task.

Since
3.4

Functions

getRules

abstract fun getRules(): MutableList<JacocoViolationRule>

Gets all violation rules. Defaults to an empty list.

isFailOnViolation

abstract fun isFailOnViolation(): Boolean

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

rule

abstract fun rule(configureAction: Action<in JacocoViolationRule>): JacocoViolationRule

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

setFailOnViolation

abstract fun setFailOnViolation(ignore: Boolean): Unit

Indicates whether build should fail in case of rule violation.