Package org.apache.maven.tools.plugin.extractor.annotations.scanner

Class DefaultMojoAnnotationsScanner

java.lang.Object

org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

All Implemented Interfaces:

MojoAnnotationsScanner

@Named
@Singleton
public class DefaultMojoAnnotationsScanner
extends Object
implements MojoAnnotationsScanner

Mojo scanner with java annotations.

Since:

3.0

Author:

Olivier Lamy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_V3
static final String	COMPONENT_V4
static final String	EXECUTE_V3
static final String	EXECUTE_V4
static final String	MOJO_V3
static final String	MOJO_V4
static final String	MVN4_API
static final String	PARAMETER_V3
static final String	PARAMETER_V4

Fields inherited from interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner

CLASS_LEVEL_ANNOTATIONS, FIELD_LEVEL_ANNOTATIONS, METHOD_LEVEL_ANNOTATIONS, ROLE, V4_API_ANNOTATIONS_PACKAGE, V4_API_PLUGIN_PACKAGE

Constructor Summary

Constructors

Constructor	Description
DefaultMojoAnnotationsScanner()

Method Summary

Modifier and Type	Method	Description
protected void	analyzeVisitors(MojoClassVisitor mojoClassVisitor)
protected void	populateAnnotationContent(Object content, MojoAnnotationVisitor mojoAnnotationVisitor)
protected void	scan(Map<String,MojoAnnotatedClass> mojoAnnotatedClasses, File source, List<String> includePatterns, org.apache.maven.artifact.Artifact artifact, boolean excludeMojo)
Map<String,MojoAnnotatedClass>	scan(MojoAnnotationsScannerRequest request)	Scan classes for mojo annotations.
protected Map<String,MojoAnnotatedClass>	scanArchive(File archiveFile, org.apache.maven.artifact.Artifact artifact, boolean excludeMojo)
protected Map<String,MojoAnnotatedClass>	scanDirectory(File classDirectory, List<String> includePatterns, org.apache.maven.artifact.Artifact artifact, boolean excludeMojo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MVN4_API

public static final String MVN4_API

See Also:

• Constant Field Values

MOJO_V4

public static final String MOJO_V4

See Also:

• Constant Field Values

EXECUTE_V4

public static final String EXECUTE_V4

See Also:

• Constant Field Values

PARAMETER_V4

public static final String PARAMETER_V4

See Also:

• Constant Field Values

COMPONENT_V4

public static final String COMPONENT_V4

See Also:

• Constant Field Values

MOJO_V3

public static final String MOJO_V3

EXECUTE_V3

public static final String EXECUTE_V3

PARAMETER_V3

public static final String PARAMETER_V3

COMPONENT_V3

public static final String COMPONENT_V3

Constructor Details

DefaultMojoAnnotationsScanner

public DefaultMojoAnnotationsScanner()

Method Details

scan

public Map<String,MojoAnnotatedClass> scan(MojoAnnotationsScannerRequest request)
                                    throws ExtractionException

Description copied from interface: MojoAnnotationsScanner

Scan classes for mojo annotations.

Specified by:

scan in interface MojoAnnotationsScanner

Parameters:

request -

Returns:

map of mojo-annotated classes keyed by full class name

Throws:

ExtractionException

scan

protected void scan(Map<String,MojoAnnotatedClass> mojoAnnotatedClasses,
 File source,
 List<String> includePatterns,
 org.apache.maven.artifact.Artifact artifact,
 boolean excludeMojo)
             throws IOException,
ExtractionException

Throws:

IOException

ExtractionException

scanArchive

protected Map<String,MojoAnnotatedClass> scanArchive(File archiveFile,
 org.apache.maven.artifact.Artifact artifact,
 boolean excludeMojo)
                                              throws IOException,
ExtractionException

Parameters:

archiveFile -

artifact -

excludeMojo - for dependencies, we exclude Mojo annotations found

Returns:

annotated classes found

Throws:

IOException

ExtractionException

scanDirectory

protected Map<String,MojoAnnotatedClass> scanDirectory(File classDirectory,
 List<String> includePatterns,
 org.apache.maven.artifact.Artifact artifact,
 boolean excludeMojo)
                                                throws IOException,
ExtractionException

Parameters:

classDirectory -

includePatterns -

artifact -

excludeMojo - for dependencies, we exclude Mojo annotations found

Returns:

annotated classes found

Throws:

IOException

ExtractionException

populateAnnotationContent

protected void populateAnnotationContent(Object content,
 MojoAnnotationVisitor mojoAnnotationVisitor)
                                  throws org.codehaus.plexus.util.reflection.ReflectorException

Throws:

org.codehaus.plexus.util.reflection.ReflectorException

analyzeVisitors

protected void analyzeVisitors(MojoClassVisitor mojoClassVisitor)
                        throws ExtractionException

Throws:

ExtractionException