Class AbstractScriptedMojoDescriptorExtractor

    • Constructor Detail

      • AbstractScriptedMojoDescriptorExtractor

        public AbstractScriptedMojoDescriptorExtractor()
    • Method Detail

      • execute

        public java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute​(PluginToolsRequest request)
                                                                                  throws ExtractionException,
                                                                                         org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
        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.
        Throws:
        ExtractionException - if any
        org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any
      • copyScriptsToOutputDirectory

        protected void copyScriptsToOutputDirectory​(java.util.Map<java.lang.String,​java.util.Set<java.io.File>> scriptFilesKeyedByBasedir,
                                                    java.lang.String outputDirectory,
                                                    PluginToolsRequest request)
                                             throws ExtractionException
        Parameters:
        scriptFilesKeyedByBasedir - not null
        outputDirectory - not null
        request - the request
        Throws:
        ExtractionException - if any
      • gatherFilesByBasedir

        protected java.util.Map<java.lang.String,​java.util.Set<java.io.File>> gatherFilesByBasedir​(java.io.File basedir,
                                                                                                         java.util.List<java.lang.String> directories,
                                                                                                         java.lang.String scriptFileExtension,
                                                                                                         PluginToolsRequest request)
        Parameters:
        basedir - not null
        directories - not null
        scriptFileExtension - not null
        request - the request
        Returns:
        map with subdirs paths as key
      • extractMojoDescriptorsFromMetadata

        protected java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptorsFromMetadata​(java.util.Map<java.lang.String,​java.util.Set<java.io.File>> metadataFilesByBasedir,
                                                                                                                       PluginToolsRequest request)
                                                                                                                throws ExtractionException,
                                                                                                                       org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
        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 java.lang.String getMetadataFileExtension​(PluginToolsRequest request)
        Should be implemented in the sub classes.
        Parameters:
        request - the request
        Returns:
        always null
      • extractMojoDescriptors

        protected java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> extractMojoDescriptors​(java.util.Map<java.lang.String,​java.util.Set<java.io.File>> scriptFilesKeyedByBasedir,
                                                                                                           PluginToolsRequest request)
                                                                                                    throws ExtractionException,
                                                                                                           org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException
        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 java.lang.String getScriptFileExtension​(PluginToolsRequest request)
        Parameters:
        request - the request
        Returns:
        the file extension like .bsh for BeanShell.