org.apache.maven.report.projectinfo
Class AbstractProjectInfoReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.report.projectinfo.AbstractProjectInfoReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

Direct Known Subclasses:

CimReport, DependenciesReport, DependencyConvergenceReport, DependencyInformationReport, DependencyManagementReport, DistributionManagementReport, IssueTrackingReport, LicenseReport, MailingListsReport, ModulesReport, PluginManagementReport, PluginsReport, ProjectIndexPageReport, ProjectSummaryReport, ScmReport, TeamListReport

public abstract class AbstractProjectInfoReport
extends AbstractMavenReport

Base class with the things that should be in AbstractMavenReport anyway.

Since:

2.0

Version:

$Id: AbstractProjectInfoReport.java 1367255 2012-07-30 20:01:21Z hboutemy $

Author:

Brett Porter

Field Summary

protected String	customBundle Path for a custom bundle instead of using the default one.
protected org.apache.maven.artifact.factory.ArtifactFactory	factory Artifact Factory component.
protected ArtifactRepository	localRepository Local Repository.
protected File	outputDirectory The output directory for the report.
protected MavenProject	project The Maven Project.
protected List<ArtifactRepository>	remoteRepositories Remote repositories used for the project.
protected ArtifactResolver	resolver Artifact Resolver component.
protected Settings	settings The current user system settings for use in Maven.
protected Renderer	siteRenderer Doxia Site Renderer component.
protected SiteTool	siteTool SiteTool 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

AbstractProjectInfoReport()

Method Summary

void	execute()
String	getCategoryName()
String	getDescription(Locale locale)
protected I18N	getI18N(Locale locale)
protected abstract String	getI18Nsection()
protected String	getI18nString(Locale locale, String key)
String	getName(Locale locale)
protected String	getOutputDirectory()
protected MavenProject	getProject()
File	getReportOutputDirectory()
protected Renderer	getSiteRenderer()
void	setReportOutputDirectory(File reportOutputDirectory)

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

canGenerateReport, closeReport, executeReport, generate, generate, generate, getSink, getSinkFactory, isExternalReport

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

getOutputName

Field Detail

siteTool

@Component
protected SiteTool siteTool

SiteTool component.

Since:

2.1

siteRenderer

@Component
protected Renderer siteRenderer

Doxia Site Renderer component.

resolver

@Component
protected ArtifactResolver resolver

Artifact Resolver component.

factory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory factory

Artifact Factory component.

outputDirectory

@Parameter(property="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.

project

@Component
protected MavenProject project

The Maven Project.

localRepository

@Parameter(property="localRepository",
           required=true,
           readonly=true)
protected ArtifactRepository localRepository

Local Repository.

remoteRepositories

@Parameter(property="project.remoteArtifactRepositories")
protected List<ArtifactRepository> remoteRepositories

Remote repositories used for the project.

Since:

2.1

settings

@Component
protected Settings settings

The current user system settings for use in Maven.

Since:

2.3

customBundle

@Parameter(defaultValue="${project.basedir}/src/site/custom/project-info-report.properties")
protected String customBundle

Path for a custom bundle instead of using the default one.
Using this field, you could change the texts in the generated reports.

Since:

2.3

Constructor Detail

AbstractProjectInfoReport

public AbstractProjectInfoReport()

Method Detail

execute

public void execute()
             throws MojoExecutionException

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractMavenReport

Throws:

MojoExecutionException

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface MavenReport

Overrides:

getCategoryName in class AbstractMavenReport

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractMavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface MavenReport

Overrides:

getReportOutputDirectory in class AbstractMavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface MavenReport

Overrides:

setReportOutputDirectory in class AbstractMavenReport

getProject

protected MavenProject getProject()

Specified by:

getProject in class AbstractMavenReport

getSiteRenderer

protected Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class AbstractMavenReport

getI18nString

protected String getI18nString(Locale locale,
                               String key)

getI18N

protected I18N getI18N(Locale locale)

getI18Nsection

protected abstract String getI18Nsection()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)