org.apache.maven.plugin.javadoc
Class TestResourcesBundleMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          org.apache.maven.plugin.javadoc.ResourcesBundleMojo
              org.apache.maven.plugin.javadoc.TestResourcesBundleMojo

All Implemented Interfaces:

ContextEnabled, Mojo

public class TestResourcesBundleMojo
extends ResourcesBundleMojo

Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options from AbstractJavadocMojo such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.

Since:

2.7

Is defined by the goal name:

test-resource-bundle

Is bound to the specified phase of the standard build lifecycle:

package

Field Summary

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

BUNDLE_OPTIONS_PATH, RESOURCES_DIR_PATH

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.plugin.Mojo

ROLE

Constructor Summary

TestResourcesBundleMojo()

Method Summary

protected String	getAttachmentClassifier() Override this if you need to provide a bundle attachment classifier, as in the case of test javadocs.
protected File	getJavadocDirectory()

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

execute

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

buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, executeReport, failOnError, getCompileArtifacts, getDependencySourcePaths, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle, isAggregator, 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

TestResourcesBundleMojo

public TestResourcesBundleMojo()

Method Detail

getAttachmentClassifier

protected String getAttachmentClassifier()

Description copied from class: AbstractJavadocMojo

Override this if you need to provide a bundle attachment classifier, as in the case of test javadocs.

Overrides:

getAttachmentClassifier in class AbstractJavadocMojo

getJavadocDirectory

protected File getJavadocDirectory()

Overrides:

getJavadocDirectory in class AbstractJavadocMojo

Returns:

the current javadoc directory