org.apache.maven.plugins.javadoc

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:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

Direct Known Subclasses:

AggregatorJavadocReport, JavadocNoForkReport, TestJavadocReport

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

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

Since:

2.0

Author:

Emmanuel Venisse, Vincent Siveton

See Also:

Javadoc Tool, Javadoc Options

Field Summary

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

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, session, 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()

Method Summary

Modifier and Type	Method and 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
void	doExecute()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
void	generate(Sink sink, Locale locale)
void	generate(Sink sink, SinkFactory sinkFactory, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setDestDir(String theDestDir)
void	setReportOutputDirectory(File reportOutputDirectory) Method to set the directory where the generated reports will be put

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

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

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(org.codehaus.doxia.sink.Sink sink,
                     Locale locale)
              throws MavenReportException

Specified by:

generate in interface MavenReport

Throws:

MavenReportException

generate

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

Throws:

MavenReportException

generate

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

Specified by:

generate in interface MavenMultiPageReport

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:

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

Parameters:

theDestDir - The destination directory.

doExecute

public void doExecute()
               throws MojoExecutionException,
                      MojoFailureException

Throws:

MojoExecutionException

MojoFailureException