Interface MojoDescriptorExtractor
-
- All Known Implementing Classes:
AbstractScriptedMojoDescriptorExtractor
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 theGroupKey
of extractor, asMojoScanner
will execute them grouped, and ordered within groups.String
getName()
Returns the "name" (id) of the extractor.default String
getRequiredJavaVersion()
The default implementation returnsnull
.boolean
isDeprecated()
Returnstrue
if extractor is deprecated.
-
-
-
Method Detail
-
isDeprecated
boolean isDeprecated()
Returnstrue
if extractor is deprecated.- Since:
- 3.7.0
-
getGroupKey
GroupKey getGroupKey()
Returns theGroupKey
of extractor, asMojoScanner
will execute them grouped, and ordered within groups. Must never returnnull
.- 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
- ThePluginToolsRequest
containing information for the extraction process.- Returns:
- a list of mojo descriptors. These may return HTML values for some fields.
- Throws:
ExtractionException
- if anyorg.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
- if any- Since:
- 2.5
-
getRequiredJavaVersion
default String getRequiredJavaVersion()
The default implementation returnsnull
.- Returns:
- the required java version or
null
if unknown - Since:
- 3.8.0
-
-