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
    • 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()