org.codehaus.mojo.cobertura

Class CoberturaReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.cobertura.CoberturaReportMojo

All Implemented Interfaces:

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

public class CoberturaReportMojo
extends org.apache.maven.reporting.AbstractMavenReport

Instruments, Tests, and Generates a Cobertura Report.

Author:

Will Gwaltney, Joakim Erdfelt

Is defined to be executed in:

phase:

test

lifecycle:

cobertura

Is defined by the goal name:

cobertura

Field Summary

Fields

Modifier and Type	Field and Description
protected File	dataFile The Datafile Location.
protected List	pluginClasspathList Maven Internal: List of artifacts for the plugin.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.codehaus.doxia.site.renderer.SiteRenderer	getSiteRenderer()
boolean	isExternalReport()
void	setReportOutputDirectory(File reportOutputDirectory)

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

closeReport, execute, getCategoryName, getReportOutputDirectory, getSink

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

dataFile

protected File dataFile

The Datafile Location.

Is defined by:

expression:

${cobertura.datafile}

default-value:

${project.build.directory}/cobertura/cobertura.ser

Is readonly.

Is required.

pluginClasspathList

protected List pluginClasspathList

Maven Internal: List of artifacts for the plugin.

Is defined by:

expression:

${plugin.artifacts}

Is readonly.

Is required.

Constructor Detail

CoberturaReportMojo

public CoberturaReportMojo()

Method Detail

getName

public String getName(Locale locale)

See Also:

MavenReport.getName(java.util.Locale)

getDescription

public String getDescription(Locale locale)

See Also:

MavenReport.getDescription(java.util.Locale)

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

Specified by:

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

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.codehaus.doxia.site.renderer.SiteRenderer getSiteRenderer()

Specified by:

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

See Also:

AbstractMavenReport.getSiteRenderer()

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

Overrides:

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

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

MavenReport.generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

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

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

getOutputName

public String getOutputName()

See Also:

MavenReport.getOutputName()

isExternalReport

public boolean isExternalReport()

Specified by:

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

Overrides:

isExternalReport 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

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

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

Overrides:

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

See Also:

AbstractMavenReport.setReportOutputDirectory(java.io.File)