Class 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
    • 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.
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException
        See Also:
        Mojo.execute()