Class AbstractScriptedMojoDescriptorExtractor

java.lang.Object
org.codehaus.plexus.logging.AbstractLogEnabled
org.apache.maven.tools.plugin.extractor.AbstractScriptedMojoDescriptorExtractor
All Implemented Interfaces:
MojoDescriptorExtractor, org.codehaus.plexus.logging.LogEnabled

@Deprecated public abstract class AbstractScriptedMojoDescriptorExtractor extends org.codehaus.plexus.logging.AbstractLogEnabled implements MojoDescriptorExtractor
Deprecated.
Scripting support for Mojos is deprecated and is planned to be removed in Maven 4.0
  • Constructor Details

    • AbstractScriptedMojoDescriptorExtractor

      public AbstractScriptedMojoDescriptorExtractor()
      Deprecated.
  • Method Details

    • isDeprecated

      public boolean isDeprecated()
      Deprecated.
      Description copied from interface: MojoDescriptorExtractor
      Returns true if extractor is deprecated.
      Specified by:
      isDeprecated in interface MojoDescriptorExtractor
    • 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:
      execute in interface MojoDescriptorExtractor
      Parameters:
      request - The PluginToolsRequest containing information for the extraction process.
      Returns:
      a list of mojo descriptors. These may return HTML values for some fields.
      Throws:
      ExtractionException - if any
      org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any
    • copyScriptsToOutputDirectory

      protected void copyScriptsToOutputDirectory(Map<String,Set<File>> scriptFilesKeyedByBasedir, String outputDirectory, PluginToolsRequest request) throws ExtractionException
      Deprecated.
      Parameters:
      scriptFilesKeyedByBasedir - not null
      outputDirectory - not null
      request - 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 null
      directories - not null
      scriptFileExtension - not null
      request - 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.InvalidPluginDescriptorException
      Deprecated.
      Should be implemented in the sub classes.
      Parameters:
      metadataFilesByBasedir - could be null
      request - The plugin request, never null.
      Returns:
      always null
      Throws:
      ExtractionException - if any
      org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any
    • getMetadataFileExtension

      protected String getMetadataFileExtension(PluginToolsRequest request)
      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.InvalidPluginDescriptorException
      Deprecated.
      Should be implemented in the sub classes.
      Parameters:
      scriptFilesKeyedByBasedir - 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 abstract String getScriptFileExtension(PluginToolsRequest request)
      Deprecated.
      Parameters:
      request - the request
      Returns:
      the file extension like .bsh for BeanShell.