Package org.apache.maven.report.projectinfo

Class IndexReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.report.projectinfo.AbstractProjectInfoReport

org.apache.maven.report.projectinfo.IndexReport

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="index")
public class IndexReport
extends AbstractProjectInfoReport

Generates the Project Index report.

Since:

2.0

Author:

Brett Porter , Vincent Siveton

Field Summary

Fields inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport

customBundle, pluginRepositories, projectBuilder, remoteRepositories, settings, skipEmptyReport

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
IndexReport(org.apache.maven.repository.RepositorySystem repositorySystem, org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.project.ProjectBuilder projectBuilder)

Method Summary

Modifier and Type	Method	Description
void	executeReport(Locale locale)
String	getDescription(Locale locale)
protected String	getI18Nsection()
String	getName(Locale locale)
String	getOutputName()

Methods inherited from class org.apache.maven.report.projectinfo.AbstractProjectInfoReport

canGenerateReport, getCategoryName, getI18N, getI18nString, getLicenseMappings, getMojoExecution, getPlugin, getPluginParameter, getReactorProjects, getSession, isEmpty

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

closeReport, constructXrefLocation, execute, generate, generate, 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 java.lang.Object

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

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

getOutputPath

Constructor Details

IndexReport

@Inject
public IndexReport(org.apache.maven.repository.RepositorySystem repositorySystem,
 org.codehaus.plexus.i18n.I18N i18n,
 org.apache.maven.project.ProjectBuilder projectBuilder)

Method Details

getName

public String getName(Locale locale)

Description copied from class: AbstractProjectInfoReport

Specified by:

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

Overrides:

getName in class AbstractProjectInfoReport

getDescription

public String getDescription(Locale locale)

Description copied from class: AbstractProjectInfoReport

Specified by:

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

Overrides:

getDescription in class AbstractProjectInfoReport

executeReport

public void executeReport(Locale locale)

Specified by:

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

getOutputName

public String getOutputName()

getI18Nsection

protected String getI18Nsection()

Specified by:

getI18Nsection in class AbstractProjectInfoReport

Returns:

The according string for the section.