org.apache.maven.plugin.jxr

Class AbstractJxrReport

public abstract class AbstractJxrReport extends AbstractMavenReport

Base class for the JXR reports.

Author: Fabrice Bellingard Brett Porter

Field Summary
protected booleanaggregate
Whether to build an aggregated report at the root, or build individual reports.
protected ListreactorProjects
The projects in the reactor for aggregation report.
Method Summary
protected booleancanGenerateReport(List sourceDirs)
booleancanGenerateReport()
protected ListconstructSourceDirs()
protected voidexecuteReport(Locale locale)
Cf. overriden method documentation.
protected ResourceBundlegetBundle(Locale locale)
Returns the correct resource bundle according to the locale
protected abstract StringgetDestinationDirectory()
protected abstract StringgetJavadocLocation()
protected StringgetOutputDirectory()
Cf. overriden method documentation.
MavenProjectgetProject()
Cf. overriden method documentation.
protected RenderergetSiteRenderer()
Cf. overriden method documentation.
protected abstract ListgetSourceRoots()
protected abstract ListgetSourceRoots(MavenProject project)
protected voidinit()
Initialize some attributes required during the report generation
booleanisExternalReport()
protected ListpruneSourceDirs(List sourceDirs)

Field Detail

aggregate

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

UNKNOWN: expression="${aggregate}" default-value="false"

reactorProjects

protected List reactorProjects
The projects in the reactor for aggregation report.

UNKNOWN: expression="${reactorProjects}"

Method Detail

canGenerateReport

protected boolean canGenerateReport(List sourceDirs)

canGenerateReport

public boolean canGenerateReport()

constructSourceDirs

protected List constructSourceDirs()

executeReport

protected void executeReport(Locale locale)
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)

getBundle

protected ResourceBundle getBundle(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

getDestinationDirectory

protected abstract String getDestinationDirectory()

getJavadocLocation

protected abstract String getJavadocLocation()

getOutputDirectory

protected String getOutputDirectory()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()

getProject

public MavenProject getProject()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#getProject()

getSiteRenderer

protected Renderer getSiteRenderer()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()

getSourceRoots

protected abstract List getSourceRoots()

getSourceRoots

protected abstract List getSourceRoots(MavenProject project)

init

protected void init()
Initialize some attributes required during the report generation

isExternalReport

public boolean isExternalReport()

pruneSourceDirs

protected List pruneSourceDirs(List sourceDirs)
Copyright © 2005-2009 Apache Software Foundation. All Rights Reserved.