org.tentackle.maven

Class AbstractAnalyzeAnnotationProcessingMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.tentackle.maven.AbstractTentackleMojo

org.tentackle.maven.AbstractTentackleAnnotationProcessingMojo

org.tentackle.maven.AbstractAnalyzeAnnotationProcessingMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AnalyzeAnnotationProcessingMojo, AnalyzeTestAnnotationProcessingMojo

public abstract class AbstractAnalyzeAnnotationProcessingMojo
extends AbstractTentackleAnnotationProcessingMojo

Generates code and meta-information prior to wurbeling and compiling the sources.

Processes up all annotations annotated with @Analyze, such as @Service.
Processing results are either written to files in analyzeDir or placed on heap for being picked up by wurblets, depending on the handler implementation for each annotation.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
protected String	index Optional generated index holding the generated services. Example: <index>META-INF/RESOURCE-INDEX.LIST</index>

Fields inherited from class org.tentackle.maven.AbstractTentackleAnnotationProcessingMojo

encoding, processors, showCompileOutput

Fields inherited from class org.tentackle.maven.AbstractTentackleMojo

charset, filesets, mavenProject, resourceDirs, verbosity, verbosityLevel

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAnalyzeAnnotationProcessingMojo() Creates a mojo.

Method Summary

Modifier and Type	Method and Description
protected void	cleanupProcessors(File srcDir) Cleans up the processors.
protected void	createMissingDirs() Creates any missing directories.
protected String[]	filterFileNames(String dirName, String[] fileNames) Filters the files to be processed. If overridden, allows to skip the annotation processing.
void	finishExecute() Finishes the execution.
protected void	initializeProcessor(AbstractTentackleProcessor processor, File srcDir) Initializes a processor.
void	setMojoParameters(File sourceDir, File analyzeDir, File servicesDir, List<String> classpathElements) Sets the mojo parameters.
protected void	validate() Checks the configuration.

Methods inherited from class org.tentackle.maven.AbstractTentackleAnnotationProcessingMojo

addProcessor, execute, getCompileErrorLog, getProcessingClassloader, getTotalCompileErrors, getTotalErrors, initializeProcessors, prepareExecute, setMojoParameters

Methods inherited from class org.tentackle.maven.AbstractTentackleMojo

determineEncoding, determineVerbosity, findResourceDirs, getCanonicalPath, getPathRelativeToBasedir, getResourceDirName

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

index

@Parameter
protected String index

Optional generated index holding the generated services.
Example: <index>META-INF/RESOURCE-INDEX.LIST</index>

Constructor Detail

AbstractAnalyzeAnnotationProcessingMojo

public AbstractAnalyzeAnnotationProcessingMojo()

Creates a mojo.

Method Detail

setMojoParameters

public void setMojoParameters(File sourceDir,
                              File analyzeDir,
                              File servicesDir,
                              List<String> classpathElements)
                       throws org.apache.maven.plugin.MojoFailureException

Sets the mojo parameters.

Parameters:

sourceDir - the directory holding the sources to be processed

analyzeDir - the directory holding the analyze results

servicesDir - the directory holding the generated services

classpathElements - the mavenProject classpath

Throws:

org.apache.maven.plugin.MojoFailureException - if classloader could not be created

validate

protected void validate()
                 throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractTentackleMojo

Checks the configuration.

Overrides:

validate in class AbstractTentackleAnnotationProcessingMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if validation failed

createMissingDirs

protected void createMissingDirs()

Creates any missing directories.

Overrides:

createMissingDirs in class AbstractTentackleAnnotationProcessingMojo

initializeProcessor

protected void initializeProcessor(AbstractTentackleProcessor processor,
                                   File srcDir)
                            throws org.apache.maven.plugin.MojoFailureException

Description copied from class: AbstractTentackleAnnotationProcessingMojo

Initializes a processor.

Overrides:

initializeProcessor in class AbstractTentackleAnnotationProcessingMojo

Parameters:

processor - the annotation processor

srcDir - the source dir

Throws:

org.apache.maven.plugin.MojoFailureException - if initialization failed

cleanupProcessors

protected void cleanupProcessors(File srcDir)
                          throws org.apache.maven.plugin.MojoFailureException

Description copied from class: AbstractTentackleAnnotationProcessingMojo

Cleans up the processors.

Overrides:

cleanupProcessors in class AbstractTentackleAnnotationProcessingMojo

Parameters:

srcDir - the current file set directory

Throws:

org.apache.maven.plugin.MojoFailureException - if cleanup failed

filterFileNames

protected String[] filterFileNames(String dirName,
                                   String[] fileNames)

Description copied from class: AbstractTentackleAnnotationProcessingMojo

Filters the files to be processed.
If overridden, allows to skip the annotation processing.

Overrides:

filterFileNames in class AbstractTentackleAnnotationProcessingMojo

Parameters:

dirName - the base directory

fileNames - the file names relative to the directory

Returns:

the filtered file names

finishExecute

public void finishExecute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Description copied from class: AbstractTentackleAnnotationProcessingMojo

Finishes the execution.

Overrides:

finishExecute in class AbstractTentackleAnnotationProcessingMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an unexpected problem occurs.

org.apache.maven.plugin.MojoFailureException - if an expected problem occurs.