org.mule.devkit.apt

Class AbstractAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.mule.devkit.apt.AbstractAnnotationProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

AnnotationProcessor

public abstract class AbstractAnnotationProcessor
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected List<? extends Verifier>	annotationVerifiers
protected Context	context
protected NotificationGatherer	notificationGatherer
protected List<PostProcessor>	postProcessors
protected PrinterGatherer	printer
protected List<Generator>	sortedModuleGenerators

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AbstractAnnotationProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createContext()
protected boolean	doProcess(Set<? extends TypeElement> annotations, RoundEnvironment env) Runs the verifiers and generators
protected void	doVerify(List<Module> modules, MultiModuleAnnotationVerifier moduleAnnotationVerifier)
protected void	doVerify(Module module, ModuleAnnotationVerifier moduleAnnotationVerifier)
abstract List<? extends Verifier>	getAnnotationVerifiers() Retrieve a list of validators for the specified object type
protected Context	getContext()
abstract List<Generator>	getGenerators() Retrieve a list of generators for the specified object type
protected abstract Plugin	getPluginFromVerifier(Verifier verifier) Given a Generator returns its containing Plugin
abstract List<PostProcessor>	getPostProcessors() Retrieve a list of post processors for the specified object type
protected void	initialize()
protected void	postProcess()
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment env) This method process the annotations.
protected void	runGenerators(List<Generator> sortedGenerators, List<Module> modules, List<Component> components)
protected void	runVerifiers(List<? extends Verifier> annotationVerifiers, List<Module> modules, List<Component> components)
protected boolean	typeExists(Set<? extends TypeElement> annotations, RoundEnvironment env)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, init, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

context

protected Context context

notificationGatherer

protected NotificationGatherer notificationGatherer

annotationVerifiers

protected List<? extends Verifier> annotationVerifiers

sortedModuleGenerators

protected List<Generator> sortedModuleGenerators

postProcessors

protected List<PostProcessor> postProcessors

printer

protected PrinterGatherer printer

Constructor Detail

AbstractAnnotationProcessor

public AbstractAnnotationProcessor()

Method Detail

getAnnotationVerifiers

public abstract List<? extends Verifier> getAnnotationVerifiers()

Retrieve a list of validators for the specified object type

Returns:

A list of validators implementing AnnotationVerifier

getGenerators

public abstract List<Generator> getGenerators()

Retrieve a list of generators for the specified object type

Returns:

A list of validators implementing ModuleGenerator

getPostProcessors

public abstract List<PostProcessor> getPostProcessors()

Retrieve a list of post processors for the specified object type

Returns:

A list of post processors implementing PostProcessor

getPluginFromVerifier

protected abstract Plugin getPluginFromVerifier(Verifier verifier)

Given a Generator returns its containing Plugin

Parameters:

verifier - Generator used to find its Plugin

Returns:

the associated Plugin

process

public boolean process(Set<? extends TypeElement> annotations,
              RoundEnvironment env)

This method process the annotations. It is called automatically by compiler.

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

Parameters:

annotations - the annotations processed

env - the environment

Returns:

true if this processor claimed the annotation and we don' want anyone else to process it.

typeExists

protected boolean typeExists(Set<? extends TypeElement> annotations,
                 RoundEnvironment env)

runVerifiers

protected void runVerifiers(List<? extends Verifier> annotationVerifiers,
                List<Module> modules,
                List<Component> components)
                     throws AnnotationVerificationException

Throws:

AnnotationVerificationException

runGenerators

protected void runGenerators(List<Generator> sortedGenerators,
                 List<Module> modules,
                 List<Component> components)
                      throws GenerationException,
                             Exception

Throws:

GenerationException

Exception

createContext

protected void createContext()

getContext

protected Context getContext()

initialize

protected void initialize()

doProcess

protected boolean doProcess(Set<? extends TypeElement> annotations,
                RoundEnvironment env)

Runs the verifiers and generators

Returns:

true is successfully processed the class. False otherwise

postProcess

protected void postProcess()

doVerify

protected void doVerify(Module module,
            ModuleAnnotationVerifier moduleAnnotationVerifier)
                 throws AnnotationVerificationException

Throws:

AnnotationVerificationException

doVerify

protected void doVerify(List<Module> modules,
            MultiModuleAnnotationVerifier moduleAnnotationVerifier)
                 throws AnnotationVerificationException

Throws:

AnnotationVerificationException