jetbrains.coverage.report.html

Interface HTMLReportBuilder

public interface HTMLReportBuilder

HTML report builder.

Method Summary

Modifier and Type	Method and Description
void	generateReport(@NotNull CoverageData coverageData) Generates report from the specified coverage data.
void	generateReport(@NotNull CoverageData older, @NotNull CoverageData newer) Generates report with coverage statistics difference according to previously gathered coverage data
void	generateReport(@NotNull CoverageData data, @NotNull StatisticsCalculator calculator) Generates report with given coverage statistics calculator.
void	setFooterHTML(@NotNull java.lang.String html) Sets footer html text for generated source
void	setReportDir(@NotNull java.io.File reportDir) Sets report directory, i.e.
void	setReportZip(@NotNull java.io.File reportZip) Sets report zip file name, i.e.
void	setSourceCodeFooterHTML(@NotNull java.lang.String html) Sets footer html text for generated pages showing source code

Method Detail

setReportDir

void setReportDir(@NotNull
                  @NotNull java.io.File reportDir)

Sets report directory, i.e. directory where report will be generated.

Parameters:

reportDir - report dir

setReportZip

void setReportZip(@NotNull
                  @NotNull java.io.File reportZip)

Sets report zip file name, i.e. file to create zipped report.

Parameters:

reportZip - report dir

generateReport

void generateReport(@NotNull
                    @NotNull CoverageData coverageData)
             throws ReportGenerationFailedException

Generates report from the specified coverage data.

Parameters:

coverageData - coverage data

Throws:

ReportGenerationFailedException - if for some reason report cannot be generated

generateReport

void generateReport(@NotNull
                    @NotNull CoverageData older,
                    @NotNull
                    @NotNull CoverageData newer)
             throws ReportGenerationFailedException

Generates report with coverage statistics difference according to previously gathered coverage data

Parameters:

older - older coverage

newer - newer coverage

Throws:

ReportGenerationFailedException - if for some reason report cannot be generated

generateReport

void generateReport(@NotNull
                    @NotNull CoverageData data,
                    @NotNull
                    @NotNull StatisticsCalculator calculator)
             throws ReportGenerationFailedException

Generates report with given coverage statistics calculator. It will call StatisticsCalculator.compute(CoverageData) before generating stats.

Parameters:

data - data

calculator - calculator

Throws:

ReportGenerationFailedException - on error

setFooterHTML

void setFooterHTML(@NotNull
                   @NotNull java.lang.String html)

Sets footer html text for generated source

Parameters:

html - text to be included into generated pages as-is

setSourceCodeFooterHTML

void setSourceCodeFooterHTML(@NotNull
                             @NotNull java.lang.String html)

Sets footer html text for generated pages showing source code

Parameters:

html - text to be included into generated pages as-is