Class InvokerReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.invoker.InvokerReport

All Implemented Interfaces:

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

@Mojo(name="report",
      threadSafe=true)
public class InvokerReport
extends org.apache.maven.reporting.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

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.codehaus.plexus.i18n.I18N	i18n	Internationalization component
private File	reportsDirectory	Base directory where all build reports have been written to.

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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	Description
InvokerReport(org.codehaus.plexus.i18n.I18N i18n)

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
private String	getI18nString(Locale locale, String key)
String	getName(Locale locale)
String	getOutputName()
private File[]	getReportFiles()

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

reportsDirectory

@Parameter(defaultValue="${project.build.directory}/invoker-reports",
           property="invoker.reportsDirectory")
private File reportsDirectory

Base directory where all build reports have been written to.

i18n

protected final org.codehaus.plexus.i18n.I18N i18n

Internationalization component

Constructor Details

InvokerReport

@Inject
public InvokerReport(org.codehaus.plexus.i18n.I18N i18n)

Method Details

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

getI18nString

private String getI18nString(Locale locale,
 String key)

Parameters:

locale - The locale

key - The key to search for

Returns:

The text appropriate for the locale.

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

getOutputName

public String getOutputName()

getReportFiles

private File[] getReportFiles()

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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