Package org.apache.maven.plugin.plugin

Class DescriptorGeneratorMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="descriptor",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      threadSafe=true)
public class DescriptorGeneratorMojo
extends AbstractGeneratorMojo

    Generate a plugin descriptor.

    Note: Since 3.0, for Java plugin annotations support, default phase defined by this goal is after the "compilation" of any scripts. This doesn't override the default binding coded at generate-resources phase in Maven core.

    Since:
    2.0
    Author:
    Jason van Zyl

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.sonatype.plexus.build.incremental.BuildContext buildContext  
      protected java.util.List<java.net.URI> externalJavadocBaseUrls
      Creates links to existing external javadoc-generated documentation.
      protected java.net.URI internalJavadocBaseUrl
      The base URL for the Javadoc site containing the current project's API documentation.
      protected java.lang.String internalJavadocVersion
      The version of the javadoc tool (equal to the container JDK version) used to generate the internal javadoc Only relevant if internalJavadocBaseUrl is set.

      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      DescriptorGeneratorMojo​(org.apache.maven.project.MavenProject project, org.apache.maven.execution.MavenSession mavenSession, org.apache.maven.tools.plugin.scanner.MojoScanner mojoScanner, org.sonatype.plexus.build.incremental.BuildContext buildContext)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void generate()  

      • 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

      • externalJavadocBaseUrls

        @Parameter(property="externalJavadocBaseUrls",
           alias="links")
protected java.util.List<java.net.URI> externalJavadocBaseUrls
        Creates links to existing external javadoc-generated documentation.
        Notes: all given links should have a fetchable /package-list or /element-list file. For instance: 
         <externalJavadocBaseUrls>
   <externalJavadocBaseUrl>https://docs.oracle.com/javase/8/docs/api/</externalJavadocBaseUrl>
 </externalJavadocBaseUrls>
        is valid because https://docs.oracle.com/javase/8/docs/api/package-list exists. See link option of the javadoc tool. Using this parameter requires connectivity to the given URLs during the goal execution.
        Since:
        3.7.0

      • internalJavadocBaseUrl

        @Parameter(property="internalJavadocBaseUrl")
protected java.net.URI internalJavadocBaseUrl
        The base URL for the Javadoc site containing the current project's API documentation. This may be relative to the root of the generated Maven site. It does not need to exist yet at the time when this goal is executed. Must end with a slash. In case this is set the javadoc reporting goal should be executed prior to Plugin Report.
        Since:
        3.7.0

      • internalJavadocVersion

        @Parameter(property="internalJavadocVersion",
           defaultValue="${java.version}")
protected java.lang.String internalJavadocVersion
        The version of the javadoc tool (equal to the container JDK version) used to generate the internal javadoc Only relevant if internalJavadocBaseUrl is set. The default value needs to be overwritten in case toolchains are being used for generating Javadoc.
        Since:
        3.7.0

      • buildContext

        protected final org.sonatype.plexus.build.incremental.BuildContext buildContext

    • Constructor Detail

      • DescriptorGeneratorMojo

        @Inject
public DescriptorGeneratorMojo​(org.apache.maven.project.MavenProject project,
                               org.apache.maven.execution.MavenSession mavenSession,
                               org.apache.maven.tools.plugin.scanner.MojoScanner mojoScanner,
                               org.sonatype.plexus.build.incremental.BuildContext buildContext)

    • Method Detail

      • generate

        public void generate()
              throws org.apache.maven.plugin.MojoExecutionException
        Specified by:
        generate in class AbstractGeneratorMojo
        Throws:
        org.apache.maven.plugin.MojoExecutionException