AntMojoDescriptorExtractor (Maven Plugin Tools 3.5.2 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
  - - org.apache.maven.tools.plugin.extractor.ant.AntMojoDescriptorExtractor

All Implemented Interfaces:

MojoDescriptorExtractor, org.codehaus.plexus.logging.LogEnabled
```
@Component(role=MojoDescriptorExtractor.class,
           hint="ant")
public class AntMojoDescriptorExtractor
extends AbstractScriptedMojoDescriptorExtractor
implements MojoDescriptorExtractor
```
Extracts Mojo descriptors from Ant sources.

Version:

$Id: AntMojoDescriptorExtractor.html 1030109 2018-05-20 14:45:18Z hboutemy $

Field Summary
- Fields inherited from interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
  ROLE

Constructor Summary

Constructors
Constructor and Description

AntMojoDescriptorExtractor()

Constructors
Constructor and Description
`AntMojoDescriptorExtractor()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected List<org.apache.maven.plugin.descriptor.MojoDescriptor>`	`extractMojoDescriptorsFromMetadata(Map<String,Set<File>> metadataFilesKeyedByBasedir, PluginToolsRequest request)` Should be implemented in the sub classes.
`protected String`	`getMetadataFileExtension(PluginToolsRequest request)` Should be implemented in the sub classes.
`protected String`	`getScriptFileExtension(PluginToolsRequest request)`

Methods inherited from class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
copyScriptsToOutputDirectory, execute, extractMojoDescriptors, gatherFilesByBasedir

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
execute

Constructor Detail
- AntMojoDescriptorExtractor
```
public AntMojoDescriptorExtractor()
```

Method Detail

extractMojoDescriptorsFromMetadata

protected List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptorsFromMetadata(Map<String,Set<File>> metadataFilesKeyedByBasedir,
                                                                                         PluginToolsRequest request)
                                                                                              throws ExtractionException,
                                                                                                     org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

Should be implemented in the sub classes.

Overrides:: extractMojoDescriptorsFromMetadata in class AbstractScriptedMojoDescriptorExtractor
Parameters:: metadataFilesKeyedByBasedir - could be null; request - The plugin request, never null.
Returns:: always null
Throws:: ExtractionException - if any; org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any

getScriptFileExtension
```
protected String getScriptFileExtension(PluginToolsRequest request)
```
Specified by:

getScriptFileExtension in class AbstractScriptedMojoDescriptorExtractor

Returns:
the file extension like .bsh for BeanShell.

getMetadataFileExtension
```
protected String getMetadataFileExtension(PluginToolsRequest request)
```
Should be implemented in the sub classes.

Overrides:

getMetadataFileExtension in class AbstractScriptedMojoDescriptorExtractor

Returns:
always null

Class AntMojoDescriptorExtractor

Field Summary

Fields inherited from interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

Constructor Detail

AntMojoDescriptorExtractor

Method Detail

extractMojoDescriptorsFromMetadata

getScriptFileExtension

getMetadataFileExtension