org.sonar.api.batch.sensor.coverage

Interface NewCoverage

All Known Implementing Classes:

DefaultCoverage

public interface NewCoverage

This builder is used to define code coverage by tests of a given type (UT/IT/Overall) on files. Example:

   sensorContext.newCoverage().onFile(file)
       .ofType(UNIT)
       .lineHits(1, 2)
       .lineHits(2, 5)
       .lineHits(3, 0)
       . ...
       .conditions(3, 4, 2)
       .conditions(12, 2, 2)
       . ...
       .save();
     
 

Since:

5.2

Method Summary

Modifier and Type	Method and Description
NewCoverage	conditions(int line, int conditions, int coveredConditions) Call this method as many time as needed to report coverage of conditions.
NewCoverage	lineHits(int line, int hits) Call this method as many time as needed to report coverage hits per line.
NewCoverage	ofType(CoverageType type)
NewCoverage	onFile(InputFile inputFile) The covered file.
void	save() Call this method only once when your are done with defining coverage of the file.

Method Detail

onFile

NewCoverage onFile(InputFile inputFile)

The covered file.

ofType

NewCoverage ofType(CoverageType type)

lineHits

NewCoverage lineHits(int line,
                     int hits)

Call this method as many time as needed to report coverage hits per line. This method should only be called for executable lines.

Parameters:

line - Line number (starts at 1).

hits - Number of time the line was hit.

conditions

NewCoverage conditions(int line,
                       int conditions,
                       int coveredConditions)

Call this method as many time as needed to report coverage of conditions.

Parameters:

line - Line number (starts at 1).

conditions - Number of conditions on this line (should be greater than 1).

coveredConditions - Number of covered conditions.

save

void save()

Call this method only once when your are done with defining coverage of the file.