Class ReportTask.CheckFormatterElement

java.lang.Object

org.jacoco.ant.ReportTask.FormatterElement

org.jacoco.ant.ReportTask.CheckFormatterElement

All Implemented Interfaces:

IViolationsOutput

Enclosing class:

ReportTask

public class ReportTask.CheckFormatterElement
extends ReportTask.FormatterElement
implements IViolationsOutput

Formatter element for coverage checks.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	failOnViolation
private final List<Rule>	rules
private boolean	violations
private String	violationsPropery

Constructor Summary

Constructors

Constructor	Description
CheckFormatterElement()

Method Summary

Modifier and Type	Method	Description
Rule	createRule()	Creates and adds a new rule.
IReportVisitor	createVisitor()
(package private) void	finish()
void	onViolation(ICoverageNode node, Rule rule, Limit limit, String message)	Called for every rule violation.
void	setFailOnViolation(boolean flag)	Sets whether the build should fail in case of a violation.
void	setViolationsProperty(String property)	Sets the name of a property to append the violation messages to.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rules

private final List<Rule> rules

violations

private boolean violations

failOnViolation

private boolean failOnViolation

violationsPropery

private String violationsPropery

Constructor Details

CheckFormatterElement

public CheckFormatterElement()

Method Details

createRule

public Rule createRule()

Creates and adds a new rule.

Returns:

new rule

setFailOnViolation

public void setFailOnViolation(boolean flag)

Sets whether the build should fail in case of a violation. Default is true.

Parameters:

flag - if true the build fails on violation

setViolationsProperty

public void setViolationsProperty(String property)

Sets the name of a property to append the violation messages to.

Parameters:

property - name of a property

createVisitor

public IReportVisitor createVisitor()
                             throws IOException

Specified by:

createVisitor in class ReportTask.FormatterElement

Throws:

IOException

onViolation

public void onViolation(ICoverageNode node,
 Rule rule,
 Limit limit,
 String message)

Description copied from interface: IViolationsOutput

Called for every rule violation.

Specified by:

onViolation in interface IViolationsOutput

Parameters:

node - node which violates a rule

rule - rule which is violated

limit - limit which is violated

message - readable message describing this violation

finish

void finish()

Overrides:

finish in class ReportTask.FormatterElement