Class JavaJavadocMojoDescriptorExtractor

  • All Implemented Interfaces:
    JavadocMojoAnnotation, org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor, org.codehaus.plexus.logging.LogEnabled

    @Named("java-javadoc")
    @Singleton
    public class JavaJavadocMojoDescriptorExtractor
    extends org.codehaus.plexus.logging.AbstractLogEnabled
    implements org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor, JavadocMojoAnnotation

    Extracts Mojo descriptors from Java source javadoc comments only. New mojos should rather rely on annotations and comments which are evaluated by extractor named java.

    For more information about the usage tag, have a look to: https://maven.apache.org/developers/mojo-api-specification.html
    See Also:
    MojoDescriptor
    • Constructor Detail

      • JavaJavadocMojoDescriptorExtractor

        public JavaJavadocMojoDescriptorExtractor()
    • Method Detail

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
      • isDeprecated

        public boolean isDeprecated()
        Specified by:
        isDeprecated in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
      • getGroupKey

        public org.apache.maven.tools.plugin.extractor.GroupKey getGroupKey()
        Specified by:
        getGroupKey in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
      • validateParameter

        protected void validateParameter​(org.apache.maven.plugin.descriptor.Parameter parameter,
                                         int i)
                                  throws org.apache.maven.plugin.descriptor.InvalidParameterException
        Parameters:
        parameter - not null
        i - positive number
        Throws:
        org.apache.maven.plugin.descriptor.InvalidParameterException - if any
      • createMojoDescriptor

        protected org.apache.maven.plugin.descriptor.MojoDescriptor createMojoDescriptor​(com.thoughtworks.qdox.model.JavaClass javaClass)
                                                                                  throws org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
        Parameters:
        javaClass - not null
        Returns:
        a mojo descriptor
        Throws:
        org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any
      • execute

        public java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute​(org.apache.maven.tools.plugin.PluginToolsRequest request)
                                                                                  throws org.apache.maven.tools.plugin.extractor.ExtractionException,
                                                                                         org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
        Specified by:
        execute in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
        Throws:
        org.apache.maven.tools.plugin.extractor.ExtractionException
        org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
      • discoverClasses

        protected java.util.Collection<com.thoughtworks.qdox.model.JavaClass> discoverClasses​(org.apache.maven.tools.plugin.PluginToolsRequest request)
        Parameters:
        request - The plugin request.
        Returns:
        an array of java class
      • validate

        protected void validate​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor)
                         throws org.apache.maven.plugin.descriptor.InvalidParameterException
        Parameters:
        mojoDescriptor - not null
        Throws:
        org.apache.maven.plugin.descriptor.InvalidParameterException - if any