org.apache.maven.tools.plugin.scanner
Interface MojoScanner

All Known Implementing Classes:

DefaultMojoScanner

public interface MojoScanner

Version:

$Id: MojoScanner.java 746400 2009-02-20 22:42:13Z bentmann $

Author:

jdcasey

Field Summary

static java.lang.String

ROLE Plexus role for lookup

Method Summary

void	populatePluginDescriptor(org.apache.maven.project.MavenProject project, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor) Deprecated. Use populatePluginDescriptor(PluginToolsRequest) instead. Provided for backward compatibility with maven-plugin-plugin < 2.5.
void	populatePluginDescriptor(PluginToolsRequest request)
void	setActiveExtractors(java.util.Set extractors) Sets the active extractors.

Field Detail

ROLE

public static final java.lang.String ROLE

Plexus role for lookup

Method Detail

populatePluginDescriptor

public void populatePluginDescriptor(org.apache.maven.project.MavenProject project,
                                     org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
                              throws ExtractionException,
                                     org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

Deprecated. Use populatePluginDescriptor(PluginToolsRequest) instead. Provided for backward compatibility with maven-plugin-plugin < 2.5.

Parameters:

project - not null

pluginDescriptor - not null

Throws:

ExtractionException - if any

org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any

populatePluginDescriptor

public void populatePluginDescriptor(PluginToolsRequest request)
                              throws ExtractionException,
                                     org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

Parameters:

request - not null

Throws:

ExtractionException - if any

org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any

Since:

2.5

setActiveExtractors

public void setActiveExtractors(java.util.Set extractors)

Sets the active extractors.

Only the specified extractors will be used, all others will be skipped.

Parameters:

extractors - The names of the sctive extractors. If this parameter is null, all the scanner's extractors are considered active. Set entries that are null or empty ("") will be ignored.