org.apache.maven.plugins.javadoc

Class TestJavadocReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocReport

org.apache.maven.plugins.javadoc.TestJavadocReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

AggregatorTestJavadocReport, TestJavadocNoForkReport

@Mojo(name="test-javadoc",
      requiresDependencyResolution=TEST,
      threadSafe=true)
 @Execute(phase=GENERATE_TEST_SOURCES)
public class TestJavadocReport
extends JavadocReport

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

Since:

2.3

Version:

$Id: TestJavadocReport.java 1747985 2016-06-12 12:04:55Z rfscholte $

See Also:

Javadoc Tool, Javadoc Options

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	destDir The name of the destination directory.
private java.io.File	reportOutputDirectory Specifies the destination directory where test Javadoc saves the generated HTML files.
private java.lang.String	testDescription The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e.
private java.lang.String	testDoctitle Specifies the Test title to be placed near the top of the overview summary file.
private java.io.File	testJavadocDirectory Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e.
private java.lang.String	testName The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e.
private java.io.File	testOverview Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
private java.lang.String	testWindowtitle Specifies the Test title to be placed in the HTML title tag.

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

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, 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
TestJavadocReport()

Method Summary

Modifier and Type	Method and Description
private void	addMainJavadocLink() Add the ../apidocs to the links parameter so Test report could be linked to the Main report.
protected SourceResolverConfig	configureDependencySourceResolution(SourceResolverConfig config) Overridden to enable the resolution of -test-sources jar files.
protected void	executeReport(java.util.Locale unusedLocale) The package documentation details the Javadoc Options used by this Plugin.
private java.util.ResourceBundle	getBundle(java.util.Locale locale) Gets the resource bundle for the specified locale.
protected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter	getDependencyScopeFilter()
java.lang.String	getDescription(java.util.Locale locale)
protected java.lang.String	getDoctitle()
protected java.util.List<java.lang.String>	getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
protected java.io.File	getJavadocDirectory()
java.lang.String	getName(java.util.Locale locale)
java.lang.String	getOutputName()
protected java.io.File	getOverview()
protected java.util.List<java.io.File>	getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
protected java.util.List<java.lang.String>	getProjectSourceRoots(org.apache.maven.project.MavenProject p)
java.io.File	getReportOutputDirectory()
protected java.lang.String	getWindowtitle()
protected boolean	isTest() Indicates whether this goal generates documentation for the Java Test code.
void	setDestDir(java.lang.String destDir)
void	setReportOutputDirectory(java.io.File reportOutputDirectory) Method to set the directory where the generated reports will be put
private void	updateReportOutputDirectory(java.io.File reportOutputDirectory, java.lang.String destDir)

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

canGenerateReport, doExecute, generate, getCategoryName, isExternalReport

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

buildJavadocOptions, canGenerateReport, collect, execute, failOnError, getAttachmentClassifier, getDependencySourcePaths, getDoclint, getFiles, getJavadocOptionsFile, getOutputDirectory, getProject, getSourcePaths, getToolchain, isAggregator, 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

Field Detail

testDoctitle

@Parameter(property="testDoctitle",
           alias="doctitle",
           defaultValue="${project.name} ${project.version} Test API")
private java.lang.String testDoctitle

Specifies the Test title to be placed near the top of the overview summary file.
See doctitle.

Since:

2.5

testOverview

@Parameter(property="testOverview",
           alias="overview",
           defaultValue="${basedir}/src/test/javadoc/overview.html")
private java.io.File testOverview

Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).
Note: could be in conflict with <nooverview/>.
See overview.

Since:

2.5

testWindowtitle

@Parameter(property="testWindowtitle",
           alias="windowtitle",
           defaultValue="${project.name} ${project.version} Test API")
private java.lang.String testWindowtitle

Specifies the Test title to be placed in the HTML title tag.
See windowtitle.

Since:

2.5

reportOutputDirectory

@Parameter(property="reportTestOutputDirectory",
           defaultValue="${project.reporting.outputDirectory}/testapidocs",
           required=true)
private java.io.File reportOutputDirectory

Specifies the destination directory where test Javadoc saves the generated HTML files.

destDir

@Parameter(property="destDir",
           defaultValue="testapidocs")
private java.lang.String destDir

The name of the destination directory.

testJavadocDirectory

@Parameter(alias="javadocDirectory",
           defaultValue="${basedir}/src/test/javadoc")
private java.io.File testJavadocDirectory

Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).
Could be used in addition of docfilessubdirs parameter.
See docfilessubdirs.

Since:

2.5

testName

@Parameter(property="testName",
           alias="name")
private java.lang.String testName

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

Since:

2.5

testDescription

@Parameter(property="testDescription",
           alias="description")
private java.lang.String testDescription

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

Since:

2.5

Constructor Detail

TestJavadocReport

public TestJavadocReport()

Method Detail

executeReport

protected void executeReport(java.util.Locale unusedLocale)
                      throws org.apache.maven.reporting.MavenReportException

Description copied from class: AbstractJavadocMojo

The package documentation details the Javadoc Options used by this Plugin.

Overrides:

executeReport in class AbstractJavadocMojo

Parameters:

unusedLocale - the wanted locale (actually unused).

Throws:

org.apache.maven.reporting.MavenReportException - if any

getName

public java.lang.String getName(java.util.Locale locale)

Description copied from class: JavadocReport

Specified by:

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

Overrides:

getName in class JavadocReport

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from class: JavadocReport

Specified by:

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

Overrides:

getDescription in class JavadocReport

getOutputName

public java.lang.String getOutputName()

Description copied from class: JavadocReport

Specified by:

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

Overrides:

getOutputName in class JavadocReport

getReportOutputDirectory

public java.io.File getReportOutputDirectory()

Description copied from class: JavadocReport

Specified by:

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

Overrides:

getReportOutputDirectory in class JavadocReport

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File reportOutputDirectory)

Method to set the directory where the generated reports will be put

Specified by:

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

Overrides:

setReportOutputDirectory in class JavadocReport

Parameters:

reportOutputDirectory - the directory file to be set

setDestDir

public void setDestDir(java.lang.String destDir)

Overrides:

setDestDir in class JavadocReport

Parameters:

destDir - The destiation directory.

updateReportOutputDirectory

private void updateReportOutputDirectory(java.io.File reportOutputDirectory,
                                         java.lang.String destDir)

getProjectBuildOutputDirs

protected java.util.List<java.io.File> getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)

Overrides:

getProjectBuildOutputDirs in class AbstractJavadocMojo

Parameters:

p - not null maven project

Returns:

the list of directories where compiled classes are placed for the given project. These dirs are added in the javadoc classpath.

getProjectSourceRoots

protected java.util.List<java.lang.String> getProjectSourceRoots(org.apache.maven.project.MavenProject p)

Overrides:

getProjectSourceRoots in class AbstractJavadocMojo

Parameters:

p - not null maven project

Returns:

the list of source paths for the given project

getExecutionProjectSourceRoots

protected java.util.List<java.lang.String> getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)

Overrides:

getExecutionProjectSourceRoots in class AbstractJavadocMojo

Parameters:

p - not null maven project

Returns:

the list of source paths for the execution project of the given project

getJavadocDirectory

protected java.io.File getJavadocDirectory()

Overrides:

getJavadocDirectory in class AbstractJavadocMojo

Returns:

the current javadoc directory

getDoctitle

protected java.lang.String getDoctitle()

Overrides:

getDoctitle in class AbstractJavadocMojo

Returns:

the title to be placed near the top of the overview summary file

getOverview

protected java.io.File getOverview()

Overrides:

getOverview in class AbstractJavadocMojo

Returns:

the overview documentation file from the user parameter or from the javadocdirectory

getWindowtitle

protected java.lang.String getWindowtitle()

Overrides:

getWindowtitle in class AbstractJavadocMojo

Returns:

the title to be placed in the HTML title tag

getDependencyScopeFilter

protected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter getDependencyScopeFilter()

Overrides:

getDependencyScopeFilter in class AbstractJavadocMojo

getBundle

private java.util.ResourceBundle getBundle(java.util.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.

addMainJavadocLink

private void addMainJavadocLink()

Add the ../apidocs to the links parameter so Test report could be linked to the Main report.

configureDependencySourceResolution

protected SourceResolverConfig configureDependencySourceResolution(SourceResolverConfig config)

Overridden to enable the resolution of -test-sources jar files. Override this method to customize the configuration for resolving dependency sources. The default behavior enables the resolution of -sources jar files.

Overrides:

configureDependencySourceResolution in class AbstractJavadocMojo

Parameters:

config - SourceResolverConfig

Returns:

SourceResolverConfig

isTest

protected boolean isTest()

Description copied from class: AbstractJavadocMojo

Indicates whether this goal generates documentation for the Java Test code.

Overrides:

isTest in class AbstractJavadocMojo

Returns:

true if the goal generates Test Javadocs, false otherwise.