Class ReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jacoco.maven.AbstractReportMojo

org.jacoco.maven.ReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="report",
      defaultPhase=VERIFY,
      threadSafe=true)
public class ReportMojo
extends AbstractReportMojo

Creates a code coverage report for tests of a single project in multiple formats (HTML, XML, and CSV).

Since:

0.5.3

Field Summary

Fields

Modifier and Type	Field	Description
private File	dataFile	File with execution data.
private File	outputDirectory	Output directory for the reports.

Fields inherited from class AbstractReportMojo

excludes, footer, formats, includes, outputEncoding, project, skip, sourceEncoding, title

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ReportMojo()

Method Summary

Modifier and Type	Method	Description
(package private) boolean	canGenerateReportRegardingClassesDirectory()
(package private) boolean	canGenerateReportRegardingDataFiles()
(package private) void	createReport(IReportGroupVisitor visitor, ReportSupport support)
String	getName(Locale locale)
(package private) File	getOutputDirectory()
String	getOutputName()
File	getReportOutputDirectory()
(package private) void	loadExecutionData(ReportSupport support)
void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class AbstractReportMojo

canGenerateReport, execute, generate, generate, getCategoryName, getDescription, getExcludes, getIncludes, isExternalReport

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}/jacoco")
private File outputDirectory

Output directory for the reports. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

dataFile

@Parameter(property="jacoco.dataFile",
           defaultValue="${project.build.directory}/jacoco.exec")
private File dataFile

File with execution data.

Constructor Details

ReportMojo

public ReportMojo()

Method Details

canGenerateReportRegardingDataFiles

boolean canGenerateReportRegardingDataFiles()

Specified by:

canGenerateReportRegardingDataFiles in class AbstractReportMojo

canGenerateReportRegardingClassesDirectory

boolean canGenerateReportRegardingClassesDirectory()

Specified by:

canGenerateReportRegardingClassesDirectory in class AbstractReportMojo

loadExecutionData

void loadExecutionData(ReportSupport support)
                throws IOException

Specified by:

loadExecutionData in class AbstractReportMojo

Throws:

IOException

getOutputDirectory

File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractReportMojo

createReport

void createReport(IReportGroupVisitor visitor,
 ReportSupport support)
           throws IOException

Specified by:

createReport in class AbstractReportMojo

Throws:

IOException

getReportOutputDirectory

public File getReportOutputDirectory()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)