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.

Version:

$Id$

Author:

Fabrice Bellingard, Brett Porter, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.apache.maven.project.MavenProject>	reactorProjects The projects in the reactor for aggregation report.
protected boolean	skip Whether to skip this execution.

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 boolean	canGenerateReport(List<String> sourceDirs)
protected List<String>	constructSourceDirs() Gets the list of the source directories to be included in the JXR report generation
void	execute()
protected void	executeReport(Locale locale)
protected ResourceBundle	getBundle(Locale locale) Returns the correct resource bundle according to the locale
protected abstract String	getDestinationDirectory() Abstract method that returns the target directory where the generated JXR reports will be put.
protected abstract File	getJavadocDir() Abstract method that returns the directory of the javadoc files.
protected String	getOutputDirectory()
protected String	getOutputEncoding() Gets the effective reporting output files encoding.
org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
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, generate, generate, generate, getCategoryName, getInputEncoding, getReportOutputDirectory, getSink, getSinkFactory, 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

@Parameter(defaultValue="${reactorProjects}",
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

The projects in the reactor for aggregation report.

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

getOutputEncoding

protected String getOutputEncoding()

Gets the effective reporting output files encoding.

Overrides:

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

Returns:

The effective reporting output file encoding, never null: defaults to UTF-8 instead.

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

getSiteRenderer

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

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

getProject

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

Overrides:

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

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

canGenerateReport

protected boolean canGenerateReport(List<String> sourceDirs)

Parameters:

sourceDirs -

Returns:

true if the report could be generated

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

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

getDestinationDirectory

protected abstract String getDestinationDirectory()

Abstract method that returns the target directory where the generated JXR reports will be put.

Returns:

a String that contains the target directory name

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

getJavadocDir

protected abstract File getJavadocDir()

Abstract method that returns the directory of the javadoc files.

Returns:

a File for the directory of the javadocs

isAggregate

protected boolean isAggregate()

Is the current report aggregated?

Returns: