JavadocReport (Apache Maven Javadoc Plugin 2.9.1 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugin.javadoc.AbstractJavadocMojo
  - - org.apache.maven.plugin.javadoc.JavadocReport

All Implemented Interfaces:

ContextEnabled, Mojo, MavenReport

Direct Known Subclasses:

AggregatorJavadocReport, TestJavadocReport
```
@Mojo(name="javadoc",
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
@Execute(phase=GENERATE_SOURCES)
public class JavadocReport
extends AbstractJavadocMojo
implements MavenReport
```
Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.

Since:

2.0

Version:

$Id: JavadocReport.html 867304 2013-06-25 01:20:34Z olamy $

Author:

Emmanuel Venisse, Vincent Siveton

See Also:
Javadoc Tool, Javadoc Options

Field Summary
- Fields inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
  aggregate, ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, 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 and Description

JavadocReport()

Constructors
Constructor and Description
`JavadocReport()`

Method Summary

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

Methods
Modifier and Type	Method and Description
`boolean`	`canGenerateReport()` The logic is the following:
`void`	`execute()`
`void`	`generate(Sink sink, Locale locale)`
`String`	`getCategoryName()`
`String`	`getDescription(Locale locale)`
`String`	`getName(Locale locale)`
`String`	`getOutputName()`
`File`	`getReportOutputDirectory()`
`protected boolean`	`isAggregator()` Indicates whether this goal is flagged with `@aggregator`.
`boolean`	`isExternalReport()`
`void`	`setDestDir(String destDir)`
`void`	`setReportOutputDirectory(File reportOutputDirectory)` Method to set the directory where the generated reports will be put

Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, executeReport, failOnError, getAttachmentClassifier, getCompileArtifacts, getDependencySourcePaths, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle, logError, resolveDependency

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
- JavadocReport
```
public JavadocReport()
```

Method Detail

getName
```
public String getName(Locale locale)
```
Specified by:

getName in interface MavenReport

getDescription
```
public String getDescription(Locale locale)
```
Specified by:

getDescription in interface MavenReport

generate

public void generate(Sink sink,
            Locale locale)
              throws MavenReportException

Specified by:: generate in interface MavenReport
Throws:: MavenReportException

getOutputName
```
public String getOutputName()
```
Specified by:

getOutputName in interface MavenReport

isExternalReport
```
public boolean isExternalReport()
```
Specified by:

isExternalReport in interface MavenReport

canGenerateReport

public boolean canGenerateReport()

The logic is the following:

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 MavenReport

getCategoryName
```
public String getCategoryName()
```
Specified by:

getCategoryName in interface MavenReport

getReportOutputDirectory
```
public File getReportOutputDirectory()
```
Specified by:

getReportOutputDirectory in interface MavenReport

setReportOutputDirectory
```
public void setReportOutputDirectory(File reportOutputDirectory)
```
Method to set the directory where the generated reports will be put

Specified by:

setReportOutputDirectory in interface MavenReport

Parameters:
reportOutputDirectory - the directory file to be set

setDestDir

public void setDestDir(String destDir)

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Specified by:: execute in interface Mojo
Throws:: MojoExecutionException; MojoFailureException

isAggregator
```
protected boolean isAggregator()
```
Description copied from class: AbstractJavadocMojo

Indicates whether this goal is flagged with @aggregator.

Overrides:

isAggregator in class AbstractJavadocMojo

Returns:
true if the goal is designed as an aggregator, false otherwise.
See Also:
AggregatorJavadocReport, AggregatorTestJavadocReport

Class JavadocReport

Field Summary

Fields inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo

Fields inherited from interface org.apache.maven.reporting.MavenReport

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo

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

Methods inherited from class java.lang.Object

Constructor Detail

JavadocReport

Method Detail

getName

getDescription

generate

getOutputName

isExternalReport

canGenerateReport

getCategoryName

getReportOutputDirectory

setReportOutputDirectory

setDestDir

execute

isAggregator