org.apache.maven.plugins.invoker

Class InvokerReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.invoker.InvokerReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

@Mojo(name="report",
      threadSafe=true)
public class InvokerReport
extends AbstractMavenReport

Generate a report based on the results of the Maven invocations. Note: This mojo doesn't fork any lifecycle, if you have a clean working copy, you have to use a command like mvn clean integration-test site to ensure the build results are present when this goal is invoked.

Since:

1.4

Author:

Olivier Lamy

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected File	outputDirectory The output directory for the report.
protected MavenProject	project The Maven Project.
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer component.

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

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	executeReport(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()

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

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, 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

Field Detail

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected MavenProject project

The Maven Project.

siteRenderer

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

Doxia Site Renderer component.

i18n

@Component
protected org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}",
           required=true)
protected File outputDirectory

The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

Constructor Detail

InvokerReport

public InvokerReport()

Method Detail

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Specified by:

executeReport in class AbstractMavenReport

Throws:

MavenReportException

getOutputDirectory

protected String getOutputDirectory()

Overrides:

getOutputDirectory in class AbstractMavenReport

getProject

protected MavenProject getProject()

Overrides:

getProject in class AbstractMavenReport

getSiteRenderer

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

Overrides:

getSiteRenderer in class AbstractMavenReport

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport