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

reactorProjects, skip

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

localRepository, outputDirectory, project, remoteRepositories, 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 String	getDestinationDirectory() Abstract method that returns the target directory where the generated JXR reports will be put.
protected File	getJavadocDir() Abstract method that returns the directory of the javadoc files.
String	getName(Locale locale)
String	getOutputName()
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
void	setReportOutputDirectory(File reportOutputDirectory)

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

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

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

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer

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

Constructor Detail

JxrReport

public JxrReport()

Method Detail

getDestinationDirectory

protected String getDestinationDirectory()

Description copied from class: AbstractJxrReport

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

Specified by:

getDestinationDirectory in class AbstractJxrReport

Returns:

a String that contains the target directory name

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

getJavadocDir

protected File getJavadocDir()

Description copied from class: AbstractJxrReport

Abstract method that returns the directory of the javadoc files.

Specified by:

getJavadocDir in class AbstractJxrReport

Returns:

a File for the directory of the javadocs

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

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

Overrides:

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