Class JavadocReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocReport

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:

AggregatorJavadocReport, JavadocNoForkReport, TestJavadocReport

@Mojo(name="javadoc",
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
@Execute(phase=GENERATE_SOURCES)
public class JavadocReport
extends AbstractJavadocMojo
implements org.apache.maven.reporting.MavenMultiPageReport

Generates documentation for the Java code in a NON aggregator project using the standard Javadoc Tool.

Since:

2.0

See Also:

• Javadoc Tool

Field Summary

Fields

Modifier and Type	Field	Description
private String	description	The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e.
private String	name	The name of the Javadoc report to be displayed in the Maven Generated Reports page (e.g.
private File	reportOutputDirectory	The current shared report output directory to use

Fields inherited from class AbstractJavadocMojo

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, locationManager, mojoExecution, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, reactorProjects, session, siteTool, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

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

Description

JavadocReport(org.apache.maven.doxia.tools.SiteTool siteTool, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, ResourceResolver resourceResolver, org.eclipse.aether.RepositorySystem repoSystem, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.apache.maven.project.ProjectBuilder mavenProjectBuilder, org.apache.maven.toolchain.ToolchainManager toolchainManager)

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()	The logic is the following: Can-generate-report Matrix isAggregator hasSourceFiles isRootProject Generate Report True True True True True True False False True False True False True False False False False True True True False True False True False False True False False False False False
protected void	doExecute()
void	generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)
void	generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale)
private ResourceBundle	getBundle(Locale locale)	Gets the resource bundle for the specified locale.
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()	Deprecated. use getOutputPath() instead
String	getOutputPath()
protected String	getPluginReportOutputDirectory()	Method that returns the plugin report output directory where the generated Javadoc report will be put beneath AbstractJavadocMojo.getOutputDirectory()/AbstractMavenReport.getReportOutputDirectory().
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File reportOutputDirectory)

Methods inherited from class AbstractJavadocMojo

buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getClassesFile, getDefaultJavadocApiLink, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getReactorProjects, getSourcePaths, getToolchain, getWindowtitle, isAggregator, isDetectOfflineLinks, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

reportOutputDirectory

private File reportOutputDirectory

The current shared report output directory to use

name

@Parameter(property="name")
private String name

The name of the Javadoc report to be displayed in the Maven Generated Reports page (e.g. project-reports.html).

Since:

2.1

description

@Parameter(property="description")
private String description

The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).

Since:

2.1

Constructor Details

JavadocReport

@Inject
public JavadocReport(org.apache.maven.doxia.tools.SiteTool siteTool,
 org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
 ResourceResolver resourceResolver,
 org.eclipse.aether.RepositorySystem repoSystem,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.apache.maven.project.ProjectBuilder mavenProjectBuilder,
 org.apache.maven.toolchain.ToolchainManager toolchainManager)

Method Details

getName

public String getName(Locale locale)

Specified by:

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

getDescription

public String getDescription(Locale locale)

Specified by:

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

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
 Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
 org.apache.maven.doxia.sink.SinkFactory sinkFactory,
 Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenMultiPageReport

Throws:

org.apache.maven.reporting.MavenReportException

getOutputName

@Deprecated
public String getOutputName()

Deprecated.

use getOutputPath() instead

Specified by:

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

getOutputPath

public String getOutputPath()

Specified by:

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

isExternalReport

public boolean isExternalReport()

Specified by:

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

canGenerateReport

public boolean canGenerateReport()
                          throws org.apache.maven.reporting.MavenReportException

The logic is the following:

Can-generate-report Matrix

isAggregator	hasSourceFiles	isRootProject	Generate Report
True	True	True	True
True	True	False	False
True	False	True	False
True	False	False	False
False	True	True	True
False	True	False	True
False	False	True	False
False	False	False	False

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getCategoryName

public String getCategoryName()

Specified by:

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

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

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

getPluginReportOutputDirectory

protected String getPluginReportOutputDirectory()

Method that returns the plugin report output directory where the generated Javadoc report will be put beneath AbstractJavadocMojo.getOutputDirectory()/AbstractMavenReport.getReportOutputDirectory().

Overrides:

getPluginReportOutputDirectory in class AbstractJavadocMojo

Returns:

a String that contains the target directory

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Specified by:

doExecute in class AbstractJavadocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getBundle

private ResourceBundle getBundle(Locale locale)

Gets the resource bundle for the specified locale.

Parameters:

locale - the locale of the currently generated report

Returns:

the resource bundle for the requested locale