MojoDescriptorExtractor (Maven Plugin Tools 3.12.0 API)

All Known Implementing Classes:

AbstractScriptedMojoDescriptorExtractor, AntMojoDescriptorExtractor, BeanshellMojoDescriptorExtractor, JavaAnnotationsMojoDescriptorExtractor, JavaJavadocMojoDescriptorExtractor
```
public interface MojoDescriptorExtractor
```
Author:

jdcasey

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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.
`default String`	`getRequiredJavaVersion()`	The default implementation returns `null`.
`boolean`	`isDeprecated()`	Returns `true` if extractor is deprecated.

- Method Detail
  - getName
```
String getName()
```
    Returns the "name" (id) of the extractor.
    
    Since:
    
    3.7.0
  - isDeprecated
```
boolean isDeprecated()
```
    Returns true if extractor is deprecated.
    
    Since:
    
    3.7.0
  - getGroupKey
```
GroupKey getGroupKey()
```
    Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups. Must never return null.
    
    Since:
    
    3.7.0
  - 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
  - getRequiredJavaVersion
```
default String getRequiredJavaVersion()
```
    The default implementation returns null.
    
    Returns:
    
    the required java version or null if unknown
    
    Since:
    
    3.8.0