Package org.apache.maven.tools.plugin.extractor

Interface MojoDescriptorExtractor

All Known Implementing Classes:
AbstractScriptedMojoDescriptorExtractor
public interface MojoDescriptorExtractor
Author:
jdcasey

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.apache.maven.plugin.descriptor.MojoDescriptor>
    execute(PluginToolsRequest request)
    Execute the mojo extraction.
    GroupKey
    getGroupKey()
    Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups.
    String
    getName()
    Returns the "name" (id) of the extractor.
    boolean
    isDeprecated()
    Returns true if extractor is deprecated.

  • Method Details

    • getName

      String getName()
      Returns the "name" (id) of the extractor.
      Since:
      TBD

    • isDeprecated

      boolean isDeprecated()
      Returns true if extractor is deprecated.
      Since:
      TBD

    • getGroupKey

      GroupKey getGroupKey()
      Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups. Must never return null.
      Since:
      TBD

    • execute

      List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute(PluginToolsRequest request) throws ExtractionException, org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
      Execute the mojo extraction.
      Parameters:
      request - The PluginToolsRequest containing information for the extraction process.
      Returns:
      a list of mojo descriptors. These may return HTML values for some fields.
      Throws:
      ExtractionException - if any
      org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any
      Since:
      2.5