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

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, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	skip Whether to skip this execution.

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

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

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
AbstractJxrReport()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected List<String>	constructSourceDirs() Gets the list of the source directories to be included in the JXR report generation
protected void	executeReport(Locale locale)
protected ResourceBundle	getBundle(Locale locale) Returns the correct resource bundle according to the locale.
protected abstract File	getJavadocLocation() Abstract method that returns the location where (Test) Javadoc is generated for this project.
protected org.apache.maven.plugin.MojoExecution	getMojoExecution()
protected abstract File	getPluginReportOutputDirectory() Abstract method that returns the plugin report output directory where the generated JXR report will be put beneath AbstractMavenReport.getReportOutputDirectory().
protected org.apache.maven.project.MavenProject	getProject()
protected List<org.apache.maven.project.MavenProject>	getReactorProjects()
protected org.apache.maven.execution.MavenSession	getSession()
protected abstract List<String>	getSourceRoots() Abstract method that returns the specified source directories that will be included in the JXR report generation.
protected abstract List<String>	getSourceRoots(org.apache.maven.project.MavenProject project) Abstract method that returns the compile source directories of the specified project that will be included in the JXR report generation
protected void	init() Initialize some attributes required during the report generation
protected boolean	isAggregate() Is the current report aggregated?
boolean	isExternalReport()
protected List<String>	pruneSourceDirs(List<String> sourceDirs) Compiles the list of directories which contain source files that will be included in the JXR report generation.

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

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, 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, getOutputPath

Field Detail

skip

@Parameter(property="maven.jxr.skip",
           defaultValue="false")
protected boolean skip

Whether to skip this execution.

Since:

2.3

Constructor Detail

AbstractJxrReport

public AbstractJxrReport()

Method Detail

pruneSourceDirs

protected List<String> pruneSourceDirs(List<String> sourceDirs)

Compiles the list of directories which contain source files that will be included in the JXR report generation.

Parameters:

sourceDirs - the List of the source directories

Returns:

a List of the directories that will be included in the JXR report generation

init

protected void init()

Initialize some attributes required during the report generation

getProject

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

Overrides:

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

getSession

protected org.apache.maven.execution.MavenSession getSession()

getReactorProjects

protected List<org.apache.maven.project.MavenProject> getReactorProjects()

getMojoExecution

protected org.apache.maven.plugin.MojoExecution getMojoExecution()

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 corresponding to the locale

executeReport

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

constructSourceDirs

protected List<String> constructSourceDirs()

Gets the list of the source directories to be included in the JXR report generation

Returns:

a List of the source directories whose contents will be included in the JXR report generation

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

isExternalReport

public boolean isExternalReport()

Specified by:

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

Overrides:

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

getPluginReportOutputDirectory

protected abstract File getPluginReportOutputDirectory()

Abstract method that returns the plugin report output directory where the generated JXR report will be put beneath AbstractMavenReport.getReportOutputDirectory().

Returns:

a File for the plugin's report output directory

getSourceRoots

protected abstract List<String> getSourceRoots()

Abstract method that returns the specified source directories that will be included in the JXR report generation.

Returns:

a List of the source directories

getSourceRoots

protected abstract List<String> getSourceRoots(org.apache.maven.project.MavenProject project)

Abstract method that returns the compile source directories of the specified project that will be included in the JXR report generation

Parameters:

project - the MavenProject where the JXR report plugin will be executed

Returns:

a List of the source directories

getJavadocLocation

protected abstract File getJavadocLocation()

Abstract method that returns the location where (Test) Javadoc is generated for this project.

Returns:

a File for the location of (test) javadoc

isAggregate

protected boolean isAggregate()

Is the current report aggregated?

Returns:

true if aggregate, false otherwise