com.atlassian.maven.plugin.clover

Class CloverReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.atlassian.maven.plugin.clover.CloverReportMojo

All Implemented Interfaces:

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

@Mojo(name="clover")
public class CloverReportMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenReport, CloverConfiguration

Generate a Clover report from existing Clover databases. The generated report is an external report generated by Clover itself. If the project generating the report is a top level project and if the aggregate configuration element is set to true then an aggregated report will also be created.

Note: This report mojo should be an @aggregator and the clover:aggregate mojo shouldn't exist. This is a limitation of the site plugin which doesn't support @aggregator reports...

Field Summary

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
CloverReportMojo()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport() Generate reports if a Clover module database or a Clover merged database exist.
void	execute()
void	executeReport(Locale locale)
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getCloverDatabase()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
org.apache.maven.project.MavenProject	getProject()
List<org.apache.maven.project.MavenProject>	getReactorProjects()
File	getReportOutputDirectory()
boolean	isExternalReport() Always return true as we're using the report generated by Clover rather than creating our own report.
boolean	isSingleCloverDatabase()
String	resolveCloverDatabase()
protected File	resolveCloverDescriptor() The logic here is taken from AbstractSiteRenderingMojo#resolveSiteDescriptor in the maven-site-plugin.
void	setReportOutputDirectory(File reportOutputDirectory)

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

Methods inherited from interface com.atlassian.maven.plugin.clover.internal.CloverConfiguration

getLog

Constructor Detail

CloverReportMojo

public CloverReportMojo()

Method Detail

execute

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

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

executeReport

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

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

public String getOutputName()

Specified by:

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

getCategoryName

public String getCategoryName()

Specified by:

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

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

getDescription

public String getDescription(Locale locale)

Specified by:

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

getProject

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

Specified by:

getProject in interface CloverConfiguration

getName

public String getName(Locale locale)

Specified by:

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

isExternalReport

public boolean isExternalReport()

Always return true as we're using the report generated by Clover rather than creating our own report.

Specified by:

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

Returns:

true

canGenerateReport

public boolean canGenerateReport()

Generate reports if a Clover module database or a Clover merged database exist.

Specified by:

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

Returns:

true if a project should be generated

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

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

resolveCloverDescriptor

protected File resolveCloverDescriptor()
                                throws org.apache.maven.reporting.MavenReportException

The logic here is taken from AbstractSiteRenderingMojo#resolveSiteDescriptor in the maven-site-plugin. See also: http://docs.codehaus.org/display/MAVENUSER/Mojo+Developer+Cookbook

Returns:

the clover report configuration file to use

Throws:

org.apache.maven.reporting.MavenReportException - if at least the default file can't be resolved

getCloverDatabase

public String getCloverDatabase()

Specified by:

getCloverDatabase in interface CloverConfiguration

resolveCloverDatabase

public String resolveCloverDatabase()

Specified by:

resolveCloverDatabase in interface CloverConfiguration

getReactorProjects

public List<org.apache.maven.project.MavenProject> getReactorProjects()

Specified by:

getReactorProjects in interface CloverConfiguration

isSingleCloverDatabase

public boolean isSingleCloverDatabase()

Specified by:

isSingleCloverDatabase in interface CloverConfiguration