DefaultMojoAnnotationsScanner (Maven Plugin Tools 3.4 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner

All Implemented Interfaces:: MojoAnnotationsScanner, org.codehaus.plexus.logging.LogEnabled

@Component(role=MojoAnnotationsScanner.class)
public class DefaultMojoAnnotationsScanner
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements MojoAnnotationsScanner

Since:: 3.0
Author:: Olivier Lamy

Field Summary
- Fields inherited from interface org.apache.maven.tools.plugin.extractor.annotations.scanner.MojoAnnotationsScanner
  CLASS_LEVEL_ANNOTATIONS, FIELD_LEVEL_ANNOTATIONS, ROLE

Constructor Summary

Constructors
Constructor and Description

DefaultMojoAnnotationsScanner()

Constructors
Constructor and Description
`DefaultMojoAnnotationsScanner()`

Method Summary

Methods
Modifier and Type	Method and 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 org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DefaultMojoAnnotationsScanner
```
public DefaultMojoAnnotationsScanner()
```

Method Detail

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

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

Class DefaultMojoAnnotationsScanner

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

Methods inherited from class java.lang.Object

Constructor Detail

DefaultMojoAnnotationsScanner

Method Detail

scan

scan

scanArchive

scanDirectory

populateAnnotationContent

analyzeVisitors