org.apache.maven.plugins.javadoc

Class ResourcesBundleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.ResourcesBundleMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

TestResourcesBundleMojo

@Mojo(name="resource-bundle",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
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

Field Summary

Fields

Modifier and Type	Field and Description
private org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager Archiver manager, used to manage jar builder.
static java.lang.String	BUNDLE_OPTIONS_PATH Bundle options path.
private java.lang.String	finalName Base name of artifacts produced by this project.
private org.apache.maven.project.MavenProjectHelper	projectHelper Helper component to provide an easy mechanism for attaching an artifact to the project for installation/deployment.
static java.lang.String	RESOURCES_DIR_PATH Resources directory path.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ResourcesBundleMojo()

Method Summary

Modifier and Type	Method and Description
void	doExecute() 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.plugins.javadoc.AbstractJavadocMojo

buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isAggregator, 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

Field Detail

BUNDLE_OPTIONS_PATH

public static final java.lang.String BUNDLE_OPTIONS_PATH

Bundle options path.

See Also:

Constant Field Values

RESOURCES_DIR_PATH

public static final java.lang.String RESOURCES_DIR_PATH

Resources directory path.

See Also:

Constant Field Values

finalName

@Parameter(defaultValue="${project.build.finalName}",
           readonly=true)
private java.lang.String finalName

Base name of artifacts produced by this project. This will be combined with AbstractJavadocMojo.getAttachmentClassifier() to produce the name for this bundle jar.

projectHelper

@Component
private org.apache.maven.project.MavenProjectHelper projectHelper

Helper component to provide an easy mechanism for attaching an artifact to the project for installation/deployment.

archiverManager

@Component
private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

Archiver manager, used to manage jar builder.

Constructor Detail

ResourcesBundleMojo

public ResourcesBundleMojo()

Method Detail

doExecute

public void doExecute()
               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.

Specified by:

doExecute in class AbstractJavadocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()