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:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.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 org.apache.maven.reporting.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

Fields

Modifier and Type	Field and Description
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 org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local Repository.
protected File	outputDirectory The output directory for the report.
protected org.apache.maven.project.MavenProject	project The Maven Project.
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepositories Remote repositories used for the project.
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver Artifact Resolver component.
protected org.apache.maven.settings.Settings	settings The current user system settings for use in Maven.
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer component.
protected org.apache.maven.doxia.tools.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

Constructors

Constructor and Description
AbstractProjectInfoReport()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
String	getCategoryName()
String	getDescription(Locale locale)
protected org.codehaus.plexus.i18n.I18N	getI18N(Locale locale)
protected abstract String	getI18Nsection()
protected String	getI18nString(Locale locale, String key)
String	getName(Locale locale)
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
File	getReportOutputDirectory()
protected org.apache.maven.doxia.siterenderer.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 org.apache.maven.doxia.tools.SiteTool siteTool

SiteTool component.

Since:

2.1

siteRenderer

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

Doxia Site Renderer component.

resolver

@Component
protected org.apache.maven.artifact.resolver.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 org.apache.maven.project.MavenProject project

The Maven Project.

localRepository

@Parameter(property="localRepository",
           required=true,
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local Repository.

remoteRepositories

@Parameter(property="project.remoteArtifactRepositories")
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories

Remote repositories used for the project.

Since:

2.1

settings

@Component
protected org.apache.maven.settings.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 org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getCategoryName

public String getCategoryName()

Specified by:

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

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Specified by:

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

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

Overrides:

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

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

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

Overrides:

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

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

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

getSiteRenderer

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

Specified by:

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

getI18nString

protected String getI18nString(Locale locale,
                   String key)

getI18N

protected org.codehaus.plexus.i18n.I18N getI18N(Locale locale)

getI18Nsection

protected abstract String getI18Nsection()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)