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

Class AntMojoDescriptorExtractor

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.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	METADATA_FILE_EXTENSION	Default metadata file extension
private static java.lang.String	SCRIPT_FILE_EXTENSION	Default Ant build file extension

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AntMojoDescriptorExtractor()

Method Summary

Modifier and Type	Method	Description
protected java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor>	extractMojoDescriptorsFromMetadata(java.util.Map<java.lang.String,java.util.Set<java.io.File>> metadataFilesKeyedByBasedir, PluginToolsRequest request)	Should be implemented in the sub classes.
protected java.lang.String	getMetadataFileExtension(PluginToolsRequest request)	Should be implemented in the sub classes.
protected java.lang.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

Field Detail

METADATA_FILE_EXTENSION

private static final java.lang.String METADATA_FILE_EXTENSION

Default metadata file extension

See Also:

Constant Field Values

SCRIPT_FILE_EXTENSION

private static final java.lang.String SCRIPT_FILE_EXTENSION

Default Ant build file extension

See Also:

Constant Field Values

Constructor Detail

AntMojoDescriptorExtractor

public AntMojoDescriptorExtractor()

Method Detail

extractMojoDescriptorsFromMetadata

protected java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptorsFromMetadata(java.util.Map<java.lang.String,java.util.Set<java.io.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 java.lang.String getScriptFileExtension(PluginToolsRequest request)

Specified by:

getScriptFileExtension in class AbstractScriptedMojoDescriptorExtractor

Parameters:

request - the request

Returns:

the file extension like .bsh for BeanShell.

getMetadataFileExtension

protected java.lang.String getMetadataFileExtension(PluginToolsRequest request)

Should be implemented in the sub classes.

Overrides:

getMetadataFileExtension in class AbstractScriptedMojoDescriptorExtractor

Parameters:

request - the request

Returns:

always null