org.apache.maven.plugin.javadoc
Class ResourcesBundleMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.javadoc.AbstractJavadocMojo
org.apache.maven.plugin.javadoc.ResourcesBundleMojo
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
- TestResourcesBundleMojo
public class ResourcesBundleMojo
- extends AbstractJavadocMojo
Bundle AbstractJavadocMojo.javadocDirectory
, along with javadoc configuration options 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:
- resource-bundle
- Is bound to the specified phase of the standard build lifecycle:
- package
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 |
Method Summary |
void |
execute()
Assemble a new JavadocOptions instance that contains the configuration options in this
mojo, which are a subset of those provided in derivatives of the AbstractJavadocMojo
class (most of the javadoc mojos, in other words). |
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, isAggregator, logError |
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 |
BUNDLE_OPTIONS_PATH
public static final String BUNDLE_OPTIONS_PATH
- See Also:
- Constant Field Values
RESOURCES_DIR_PATH
public static final String RESOURCES_DIR_PATH
- See Also:
- Constant Field Values
ResourcesBundleMojo
public ResourcesBundleMojo()
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException
- Assemble a new
JavadocOptions
instance that contains the configuration options in this
mojo, which are a subset of those provided in derivatives of the AbstractJavadocMojo
class (most of the javadoc mojos, in other words). Then, bundle the contents of the
javadocDirectory
along with the assembled JavadocOptions instance (serialized to
META-INF/maven/javadoc-options.xml) into a project attachment for installation/deployment.
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
- See Also:
Mojo.execute()
Copyright © 2004-2011 The Apache Software Foundation. All Rights Reserved.