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

Direct Known Subclasses:

CimReport, DependenciesReport, DependencyConvergenceReport, DependencyManagementReport, IssueTrackingReport, LicenseReport, MailingListsReport, 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 728546 2008-12-21 22:56:51Z bentmann $

Author:

Brett Porter

Field Summary

protected org.apache.maven.artifact.factory.ArtifactFactory	factory Artifact Factory component.
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization 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 org.apache.maven.artifact.resolver.ArtifactResolver	resolver Artifact Resolver component.
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

AbstractProjectInfoReport()

Method Summary

void	execute()
String	getCategoryName()
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, getSink, 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

getDescription, getName, getOutputName

Field Detail

siteTool

protected org.apache.maven.doxia.tools.SiteTool siteTool

SiteTool component.

Since:

2.1

Is a Plexus component defined by:

siteRenderer

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

Doxia Site Renderer component.

Is a Plexus component defined by:

resolver

protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

Artifact Resolver component.

Is a Plexus component defined by:

factory

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

Artifact Factory component.

Is a Plexus component defined by:

i18n

protected org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

Is a Plexus component defined by:

outputDirectory

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.

Is defined by:

expression:

${project.reporting.outputDirectory}

Is required.

project

protected org.apache.maven.project.MavenProject project

The Maven Project.

Is defined by:

expression:

${project}

Is readonly.

Is required.

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local Repository.

Is defined by:

expression:

${localRepository}

Is readonly.

Is required.

Constructor Detail

AbstractProjectInfoReport

public AbstractProjectInfoReport()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getCategoryName

public String getCategoryName()

getOutputDirectory

protected String getOutputDirectory()

getReportOutputDirectory

public File getReportOutputDirectory()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

getProject

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

getSiteRenderer

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