org.codehaus.mojo.cobertura
Class CoberturaReportMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.reporting.AbstractMavenReport
          extended by org.codehaus.mojo.cobertura.CoberturaReportMojo
All Implemented Interfaces:
ContextEnabled, Mojo, MavenReport

public class CoberturaReportMojo
extends 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
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
CoberturaReportMojo()
           
 
Method Summary
 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  MavenProject getProject()
           
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 boolean isExternalReport()
           
 void setReportOutputDirectory(File reportOutputDirectory)
           
 
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, execute, 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

dataFile

protected File dataFile

The Datafile Location.

Is readonly.
Is defined by:
expression:
${cobertura.datafile}
default-value:
${project.build.directory}/cobertura/cobertura.ser
Is required.

pluginClasspathList

protected List pluginClasspathList
Maven Internal: List of artifacts for the plugin.

Is readonly.
Is defined by:
expression:
${plugin.artifacts}
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 AbstractMavenReport
See Also:
AbstractMavenReport.getOutputDirectory()

getProject

protected MavenProject getProject()
Specified by:
getProject in class AbstractMavenReport
See Also:
AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
Specified by:
getSiteRenderer in class AbstractMavenReport
See Also:
AbstractMavenReport.getSiteRenderer()

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws MavenReportException
Specified by:
generate in interface MavenReport
Overrides:
generate in class AbstractMavenReport
Throws:
MavenReportException
See Also:
MavenReport.generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException
Specified by:
executeReport in class AbstractMavenReport
Throws:
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 MavenReport
Overrides:
isExternalReport in class AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface MavenReport
Overrides:
canGenerateReport in class AbstractMavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)
Specified by:
setReportOutputDirectory in interface MavenReport
Overrides:
setReportOutputDirectory in class AbstractMavenReport
See Also:
AbstractMavenReport.setReportOutputDirectory(java.io.File)


Copyright © 2005-2011 Codehaus. All Rights Reserved.