org.jacoco.maven

Class AbstractReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.jacoco.maven.AbstractReportMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ReportITMojo, ReportMojo

public abstract class AbstractReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

Author:

Mirko Friedenhagen

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	excludes A list of class files to exclude from the report.
protected ExecutionDataStore	executionDataStore
protected List<String>	includes A list of class files to include in the report.
protected String	outputEncoding Encoding of the generated reports.
protected org.apache.maven.project.MavenProject	project Maven project.
protected SessionInfoStore	sessionInfoStore
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer.
protected boolean	skip Flag used to suppress execution.
protected String	sourceEncoding Encoding of the source files.

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 and Description
AbstractReportMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	checkForMissingDebugInformation(ICoverageNode node)
protected void	createReport(IReportGroupVisitor visitor)
protected IReportVisitor	createVisitor(Locale locale)
void	execute() This method is called when the report generation is invoked directly as a standalone Mojo.
protected void	executeReport(Locale locale)
protected List<File>	getCompileSourceRoots()
protected abstract File	getDataFile()
String	getDescription(Locale locale)
protected List<String>	getExcludes() Returns the list of class files to exclude from the report.
protected List<String>	getIncludes() Returns the list of class files to include in the report.
abstract String	getName(Locale locale)
protected abstract String	getOutputDirectory()
protected abstract File	getOutputDirectoryFile()
abstract String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExternalReport()
protected void	loadExecutionData()
protected File	resolvePath(String path)
abstract void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

outputEncoding

protected String outputEncoding

Encoding of the generated reports.

sourceEncoding

protected String sourceEncoding

Encoding of the source files.

includes

protected List<String> includes

A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.

excludes

protected List<String> excludes

A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.

skip

protected boolean skip

Flag used to suppress execution.

project

protected org.apache.maven.project.MavenProject project

Maven project.

siteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer.

sessionInfoStore

protected SessionInfoStore sessionInfoStore

executionDataStore

protected ExecutionDataStore executionDataStore

Constructor Detail

AbstractReportMojo

public AbstractReportMojo()

Method Detail

getOutputName

public abstract String getOutputName()

getName

public abstract String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected abstract String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getIncludes

protected List<String> getIncludes()

Returns the list of class files to include in the report.

Returns:

class files to include, may contain wildcard characters

getExcludes

protected List<String> getExcludes()

Returns the list of class files to exclude from the report.

Returns:

class files to exclude, may contain wildcard characters

setReportOutputDirectory

public abstract void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

Overrides:

setReportOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

This method is called when the report generation is invoked directly as a standalone Mojo.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.plugin.MojoExecutionException

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

loadExecutionData

protected void loadExecutionData()
                          throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

createReport

protected void createReport(IReportGroupVisitor visitor)
                     throws IOException

Throws:

IOException

checkForMissingDebugInformation

protected void checkForMissingDebugInformation(ICoverageNode node)

createVisitor

protected IReportVisitor createVisitor(Locale locale)
                                throws IOException

Throws:

IOException

resolvePath

protected File resolvePath(String path)

getCompileSourceRoots

protected List<File> getCompileSourceRoots()

getDataFile

protected abstract File getDataFile()

getOutputDirectoryFile

protected abstract File getOutputDirectoryFile()