de.smartics.testdoc.maven
Class TestDocReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          de.smartics.testdoc.maven.AbstractReportMojo
              de.smartics.testdoc.maven.AbstractSourceReportMojo
                  de.smartics.testdoc.maven.TestDocReportMojo

All Implemented Interfaces:

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

public class TestDocReportMojo
     
     

      
      extends 
      
      AbstractSourceReportMojo
     
     

Generates XDoc reports.

Author:

Robert Reiner

maven-goal:

test-stories-report

maven-requiresProject:

maven-description:

Generates XDoc reports.

Field Summary

Fields inherited from class de.smartics.testdoc.maven.AbstractSourceReportMojo

coberturaLocation, imageHelper, javadocLocation, javadocTestLocation, junitManager, junitReportLocation, linkCobertura, linkJavadoc, linkJavadocTest, linkSurefire, linkXref, linkXrefTest, presentJUnitReport, reports, surefireLocation, xrefLocation, xrefTestLocation

Fields inherited from class de.smartics.testdoc.maven.AbstractReportMojo

description, factory, locale, localRepository, logLevel, messages, name, outputDirectory, outputName, project, resolver, siteRenderer

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

TestDocReportMojo()

Method Summary

boolean	canGenerateReport()
protected void	executeReport(Locale locale) Configures the plugin logger.
protected void	exportIndex(Locale locale)
protected void	exportSinkReport(List<ExportIndex> exportIndices, de.smartics.testdoc.core.doc.UnitTestDocIndex index)
protected void	exportXmlReport(List<ExportIndex> exportIndices, de.smartics.testdoc.core.doc.UnitTestDocIndex index)

Methods inherited from class de.smartics.testdoc.maven.AbstractSourceReportMojo

createStrategy

Methods inherited from class de.smartics.testdoc.maven.AbstractReportMojo

execute, getBundle, getDescription, getName, getOutputDirectory, getOutputName, getProject, getSiteRenderer

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

closeReport, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory

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

Constructor Detail

TestDocReportMojo

public TestDocReportMojo()

Method Detail

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Configures the plugin logger.

Configures the plugin logger.

Overrides:

executeReport in class AbstractSourceReportMojo

Throws:

MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

exportIndex

protected void exportIndex(Locale locale)
                    throws MavenReportException

Throws:

MavenReportException

exportSinkReport

protected void exportSinkReport(List<ExportIndex> exportIndices,
                                de.smartics.testdoc.core.doc.UnitTestDocIndex index)
                         throws IOException

Throws:

IOException

exportXmlReport

protected void exportXmlReport(List<ExportIndex> exportIndices,
                               de.smartics.testdoc.core.doc.UnitTestDocIndex index)
                        throws IOException

Throws:

IOException

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractReportMojo

See Also:

AbstractMavenReport.canGenerateReport()