org.tentackle.maven

Class AbstractTentackleAnnotationProcessingMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.tentackle.maven.AbstractTentackleMojo

org.tentackle.maven.AbstractTentackleAnnotationProcessingMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAnalyzeAnnotationProcessingMojo

public abstract class AbstractTentackleAnnotationProcessingMojo
extends AbstractTentackleMojo

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

Picks up all annotations annotated with org.tentackle.common.Analyze.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
protected String	encoding Source file encode.
protected List<AbstractTentackleProcessor>	processors Annotation processors.
protected boolean	showCompileOutput Show compile output.

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
AbstractTentackleAnnotationProcessingMojo()

Method Summary

Modifier and Type	Method and Description
void	addProcessor(AbstractTentackleProcessor processor) Adds an annotation processor.
protected void	cleanupProcessors(File srcDir) Cleans up the processors.
protected void	createMissingDirs() Creates any missing directories.
void	execute()
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.
String	getCompileErrorLog() Gets the compiler error log.
ClassLoader	getProcessingClassloader() Gets a classloader that searches also in the classpath elements of the project.
int	getTotalCompileErrors() Gets the number of compile errors.
int	getTotalErrors() Gets the number of analyze errors.
protected void	initializeProcessor(AbstractTentackleProcessor processor, File srcDir) Initializes a processor.
protected void	initializeProcessors(File srcDir) Initializes all processors.
void	prepareExecute() Prepares the execution. Invoked before validate().
void	setMojoParameters(File sourceDir, List<String> classpathElements) Sets the mojo parameters.
protected void	validate() Checks the configuration.

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

showCompileOutput

@Parameter(defaultValue="${tentackle.showCompileOutput}")
protected boolean showCompileOutput

Show compile output.

encoding

@Parameter(defaultValue="${project.build.sourceEncoding}")
protected String encoding

Source file encode.

processors

protected List<AbstractTentackleProcessor> processors

Annotation processors.

Constructor Detail

AbstractTentackleAnnotationProcessingMojo

public AbstractTentackleAnnotationProcessingMojo()

Method Detail

setMojoParameters

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

Sets the mojo parameters.

Parameters:

sourceDir - the directory holding the sources to be processed

classpathElements - the mavenProject classpath

Throws:

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

getProcessingClassloader

public ClassLoader getProcessingClassloader()

Gets a classloader that searches also in the classpath elements of the project.

Returns:

the classloader

addProcessor

public void addProcessor(AbstractTentackleProcessor processor)

Adds an annotation processor.

Parameters:

processor - the annotation processor

createMissingDirs

protected void createMissingDirs()

Creates any missing directories.

prepareExecute

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

Prepares the execution.
Invoked before validate().

Throws:

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

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

finishExecute

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

Finishes the execution.

Throws:

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

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

getTotalCompileErrors

public int getTotalCompileErrors()

Gets the number of compile errors.

Returns:

0 if analyze phase completed, > 0 if analyze info may be incomplete due to errors

getCompileErrorLog

public String getCompileErrorLog()

Gets the compiler error log.

Returns:

the log, empty if no errors

getTotalErrors

public int getTotalErrors()

Gets the number of analyze errors.

Returns:

the error count

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

validate

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

Description copied from class: AbstractTentackleMojo

Checks the configuration.

Overrides:

validate in class AbstractTentackleMojo

Throws:

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

initializeProcessor

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

Initializes a processor.

Parameters:

processor - the annotation processor

srcDir - the source dir

Throws:

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

initializeProcessors

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

Initializes all processors.

Parameters:

srcDir - the current file set directory

Throws:

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

cleanupProcessors

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

Cleans up the processors.

Parameters:

srcDir - the current file set directory

Throws:

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

filterFileNames

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

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

Parameters:

dirName - the base directory

fileNames - the file names relative to the directory

Returns:

the filtered file names