org.apache.maven.plugin.jxr

Class JxrReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugin.jxr.AbstractJxrReport

org.apache.maven.plugin.jxr.JxrReport

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:

AggregatorJxrReport, JxrNoForkReport

@Mojo(name="jxr")
 @Execute(phase=GENERATE_SOURCES)
public class JxrReport
extends AbstractJxrReport

Creates an HTML-based, cross referenced version of Java source code for a project.

Author:

Fabrice Bellingard

Field Summary

Fields inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport

skip

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

Method Summary

Modifier and Type	Method and Description
String	getDescription(Locale locale)
protected File	getJavadocLocation() Abstract method that returns the location where (Test) Javadoc is generated for this project.
String	getName(Locale locale)
String	getOutputName()
protected File	getPluginReportOutputDirectory() Abstract method that returns the plugin report output directory where the generated JXR report will be put beneath AbstractMavenReport.getReportOutputDirectory().
protected List<String>	getSourceRoots() Abstract method that returns the specified source directories that will be included in the JXR report generation.
protected 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

Methods inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport

canGenerateReport, constructSourceDirs, executeReport, getBundle, getMojoExecution, getProject, getReactorProjects, getSession, init, isAggregate, isExternalReport, pruneSourceDirs

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

getOutputPath

Constructor Detail

JxrReport

public JxrReport()

Method Detail

getPluginReportOutputDirectory

protected File getPluginReportOutputDirectory()

Description copied from class: AbstractJxrReport

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

Specified by:

getPluginReportOutputDirectory in class AbstractJxrReport

Returns:

a File for the plugin's report output directory

getSourceRoots

protected List<String> getSourceRoots()

Description copied from class: AbstractJxrReport

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

Specified by:

getSourceRoots in class AbstractJxrReport

Returns:

a List of the source directories

getSourceRoots

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

Description copied from class: AbstractJxrReport

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

Specified by:

getSourceRoots in class AbstractJxrReport

Parameters:

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

Returns:

a List of the source directories

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getOutputName

public String getOutputName()

getJavadocLocation

protected File getJavadocLocation()

Description copied from class: AbstractJxrReport

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

Specified by:

getJavadocLocation in class AbstractJxrReport

Returns:

a File for the location of (test) javadoc