org.apache.maven.plugin.jxr
Class AbstractJxrReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          org.apache.maven.plugin.jxr.AbstractJxrReport

All Implemented Interfaces:

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

Direct Known Subclasses:

JxrReport, JxrTestReport

public abstract class AbstractJxrReport

extends org.apache.maven.reporting.AbstractMavenReport

Base class for the JXR reports.

Author:

Fabrice Bellingard, Brett Porter

Field Summary

protected boolean	aggregate Whether to build an aggregated report at the root, or build individual reports.
protected java.util.List	reactorProjects The projects in the reactor for aggregation report.

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

AbstractJxrReport()

Method Summary

boolean	canGenerateReport()
protected boolean	canGenerateReport(java.util.List sourceDirs)
protected java.util.List	constructSourceDirs()
protected void	executeReport(java.util.Locale locale) Cf.
protected java.util.ResourceBundle	getBundle(java.util.Locale locale) Returns the correct resource bundle according to the locale
protected abstract java.lang.String	getDestinationDirectory()
protected abstract java.lang.String	getJavadocLocation()
protected java.lang.String	getOutputDirectory() Cf.
org.apache.maven.project.MavenProject	getProject() Cf.
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer() Cf.
protected abstract java.util.List	getSourceRoots()
protected abstract java.util.List	getSourceRoots(org.apache.maven.project.MavenProject project)
protected void	init() Initialize some attributes required during the report generation
boolean	isExternalReport()
protected java.util.List	pruneSourceDirs(java.util.List sourceDirs)

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

closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, 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

getDescription, getName, getOutputName

Field Detail

reactorProjects

protected java.util.List reactorProjects

The projects in the reactor for aggregation report.

aggregate

protected boolean aggregate

Whether to build an aggregated report at the root, or build individual reports.

Constructor Detail

AbstractJxrReport

public AbstractJxrReport()

Method Detail

pruneSourceDirs

protected java.util.List pruneSourceDirs(java.util.List sourceDirs)

init

protected void init()

Initialize some attributes required during the report generation

getSiteRenderer

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

Cf. overriden method documentation.

See Also:

AbstractMavenReport.getSiteRenderer()

getOutputDirectory

protected java.lang.String getOutputDirectory()

Cf. overriden method documentation.

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

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

Cf. overriden method documentation.

See Also:

AbstractMavenReport.getProject()

getBundle

protected java.util.ResourceBundle getBundle(java.util.Locale locale)

Returns the correct resource bundle according to the locale

Parameters:

locale - : the locale of the user

Returns:

the bundle correponding to the locale

canGenerateReport

protected boolean canGenerateReport(java.util.List sourceDirs)

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Cf. overriden method documentation.

Throws:

org.apache.maven.reporting.MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)

constructSourceDirs

protected java.util.List constructSourceDirs()

canGenerateReport

public boolean canGenerateReport()

isExternalReport

public boolean isExternalReport()

getDestinationDirectory

protected abstract java.lang.String getDestinationDirectory()

getSourceRoots

protected abstract java.util.List getSourceRoots()

getSourceRoots

protected abstract java.util.List getSourceRoots(org.apache.maven.project.MavenProject project)

getJavadocLocation

protected abstract java.lang.String getJavadocLocation()