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

Deprecated.

Scripting support for mojos is deprecated and is planned tp be removed in maven 4.0

@Deprecated
 @Named(value="ant")
 @Singleton
public class AntMojoDescriptorExtractor
extends AbstractScriptedMojoDescriptorExtractor

Extracts Mojo descriptors from Ant sources.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Deprecated.

Constructor Summary

Constructors

Constructor and Description
AntMojoDescriptorExtractor() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected List<org.apache.maven.plugin.descriptor.MojoDescriptor>	extractMojoDescriptorsFromMetadata(Map<String,Set<File>> metadataFilesKeyedByBasedir, PluginToolsRequest request) Deprecated. Should be implemented in the sub classes.
GroupKey	getGroupKey() Deprecated. Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups.
protected String	getMetadataFileExtension(PluginToolsRequest request) Deprecated. Should be implemented in the sub classes.
String	getName() Deprecated. Returns the "name" (id) of the extractor.
protected String	getScriptFileExtension(PluginToolsRequest request) Deprecated.

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

copyScriptsToOutputDirectory, execute, extractMojoDescriptors, gatherFilesByBasedir, isDeprecated

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

getRequiredJavaVersion

Field Detail

NAME

public static final String NAME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AntMojoDescriptorExtractor

public AntMojoDescriptorExtractor()

Deprecated.

Method Detail

getName

public String getName()

Deprecated.

Description copied from interface: MojoDescriptorExtractor

Returns the "name" (id) of the extractor.

getGroupKey

public GroupKey getGroupKey()

Deprecated.

Description copied from interface: MojoDescriptorExtractor

Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups. Must never return null.

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

Deprecated.

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)

Deprecated.

Specified by:

getScriptFileExtension in class AbstractScriptedMojoDescriptorExtractor

Parameters:

request - the request

Returns:

the file extension like .bsh for BeanShell.

getMetadataFileExtension

protected String getMetadataFileExtension(PluginToolsRequest request)

Deprecated.

Should be implemented in the sub classes.

Overrides:

getMetadataFileExtension in class AbstractScriptedMojoDescriptorExtractor

Parameters:

request - the request

Returns:

always null