Class AbstractScriptedMojoDescriptorExtractor
java.lang.Object
org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
- All Implemented Interfaces:
MojoDescriptorExtractor
@Deprecated
public abstract class AbstractScriptedMojoDescriptorExtractor
extends Object
implements MojoDescriptorExtractor
Deprecated.
Scripting support for Mojos is deprecated and is planned to be removed in Maven 4.0
- Author:
- jdcasey
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcopyScriptsToOutputDirectory(Map<String, Set<File>> scriptFilesKeyedByBasedir, String outputDirectory, PluginToolsRequest request) Deprecated.List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute(PluginToolsRequest request) Deprecated.Execute the mojo extraction.protected List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptors(Map<String, Set<File>> scriptFilesKeyedByBasedir, PluginToolsRequest request) Deprecated.Should be implemented in the sub classes.protected List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptorsFromMetadata(Map<String, Set<File>> metadataFilesByBasedir, PluginToolsRequest request) Deprecated.Should be implemented in the sub classes.gatherFilesByBasedir(File basedir, List<String> directories, String scriptFileExtension, PluginToolsRequest request) Deprecated.protected StringDeprecated.Should be implemented in the sub classes.protected abstract StringgetScriptFileExtension(PluginToolsRequest request) Deprecated.booleanDeprecated.Returnstrueif extractor is deprecated.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor
getGroupKey, getName, getRequiredJavaVersion
-
Constructor Details
-
AbstractScriptedMojoDescriptorExtractor
Deprecated.
-
-
Method Details
-
isDeprecated
Deprecated.Description copied from interface:MojoDescriptorExtractorReturnstrueif extractor is deprecated.- Specified by:
isDeprecatedin interfaceMojoDescriptorExtractor
-
execute
public List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute(PluginToolsRequest request) throws ExtractionException, org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException Deprecated.Execute the mojo extraction.- Specified by:
executein interfaceMojoDescriptorExtractor- Parameters:
request- ThePluginToolsRequestcontaining 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
-
copyScriptsToOutputDirectory
protected void copyScriptsToOutputDirectory(Map<String, Set<File>> scriptFilesKeyedByBasedir, String outputDirectory, PluginToolsRequest request) throws ExtractionExceptionDeprecated.- Parameters:
scriptFilesKeyedByBasedir- not nulloutputDirectory- not nullrequest- the request- Throws:
ExtractionException- if any
-
gatherFilesByBasedir
protected Map<String,Set<File>> gatherFilesByBasedir(File basedir, List<String> directories, String scriptFileExtension, PluginToolsRequest request) Deprecated.- Parameters:
basedir- not nulldirectories- not nullscriptFileExtension- not nullrequest- the request- Returns:
- map with subdirs paths as key
-
extractMojoDescriptorsFromMetadata
protected List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptorsFromMetadata(Map<String, Set<File>> metadataFilesByBasedir, PluginToolsRequest request) throws ExtractionException, org.apache.maven.plugin.descriptor.InvalidPluginDescriptorExceptionDeprecated.Should be implemented in the sub classes.- Parameters:
metadataFilesByBasedir- could be nullrequest- The plugin request, nevernull.- Returns:
- always null
- Throws:
ExtractionException- if anyorg.apache.maven.plugin.descriptor.InvalidPluginDescriptorException- if any
-
getMetadataFileExtension
Deprecated.Should be implemented in the sub classes.- Parameters:
request- the request- Returns:
- always null
-
extractMojoDescriptors
protected List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptors(Map<String, Set<File>> scriptFilesKeyedByBasedir, PluginToolsRequest request) throws ExtractionException, org.apache.maven.plugin.descriptor.InvalidPluginDescriptorExceptionDeprecated.Should be implemented in the sub classes.- Parameters:
scriptFilesKeyedByBasedir- could be nullrequest- The plugin request, nevernull.- Returns:
- always null
- Throws:
ExtractionException- if anyorg.apache.maven.plugin.descriptor.InvalidPluginDescriptorException- if any
-
getScriptFileExtension
Deprecated.- Parameters:
request- the request- Returns:
- the file extension like
.bshfor BeanShell.
-