Class BaseAnnotationProcessorManager
- All Implemented Interfaces:
IProcessorProvider
- Direct Known Subclasses:
BatchAnnotationProcessorManager
RoundDispatcher
. There may be multiple instances of this class;
there is in general one of these for every Compiler that has annotation
processing enabled. Within the IDE there will typically be one for every
Java project, because each project potentially has a separate processor path.
TODO: do something useful with _supportedOptions and _supportedAnnotationTypes.-
Field Summary
Modifier and TypeFieldDescriptionprotected PrintWriter
boolean
protected PrintWriter
protected boolean
protected boolean
protected BaseProcessingEnvImpl
protected List
<ProcessorInfo> The list of processors that have been loaded so far.protected int
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Configure the receiver using the given batch compiler and the given options.void
configureFromPlatform
(Compiler compiler, Object compilationUnitLocator, Object javaProject, boolean isTestCode) Configure the receiver using the given compiler, the given compilationUnitLocator and the given java project.Returns the deleted units.Return the new binary bindings created in the last round.Return the new units created in the last round.void
processAnnotations
(CompilationUnitDeclaration[] units, ReferenceBinding[] referenceBindings, boolean isLastRound) A single "round" of processing, in the sense implied inProcessor
.void
reset()
Reinitialize the receivervoid
setErr
(PrintWriter err) Set the print writer for the standard error.void
setOut
(PrintWriter out) Set the print writer for the standard output.void
setProcessors
(Object[] processors) Set the processors for annotation processing.Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.AbstractAnnotationProcessorManager
cleanUp, closeClassLoader
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.apt.dispatch.IProcessorProvider
discoverNextProcessor, reportProcessorException
-
Field Details
-
_out
-
_err
-
_processingEnv
-
_isFirstRound
public boolean _isFirstRound -
_processors
The list of processors that have been loaded so far. A processor on this list has been initialized, but may not yet have been called to process(). -
_printProcessorInfo
protected boolean _printProcessorInfo -
_printRounds
protected boolean _printRounds -
_round
protected int _round
-
-
Constructor Details
-
BaseAnnotationProcessorManager
public BaseAnnotationProcessorManager()
-
-
Method Details
-
configure
Description copied from class:AbstractAnnotationProcessorManager
Configure the receiver using the given batch compiler and the given options. The parameter batchCompiler is expected to be an instance of the batch compiler. This method is only used for the batch mode. For the IDE mode, please seeAbstractAnnotationProcessorManager.configureFromPlatform(Compiler, Object, Object, boolean)
.- Specified by:
configure
in classAbstractAnnotationProcessorManager
- Parameters:
batchCompiler
- the given batch compiler objectoptions
- the given options
-
configureFromPlatform
public void configureFromPlatform(Compiler compiler, Object compilationUnitLocator, Object javaProject, boolean isTestCode) Description copied from class:AbstractAnnotationProcessorManager
Configure the receiver using the given compiler, the given compilationUnitLocator and the given java project.- Specified by:
configureFromPlatform
in classAbstractAnnotationProcessorManager
- Parameters:
compiler
- the given compilercompilationUnitLocator
- the given compilation unit locatorjavaProject
- the given java project
-
getDiscoveredProcessors
- Specified by:
getDiscoveredProcessors
in interfaceIProcessorProvider
- Returns:
- the list of all processors that have been discovered so far. This list will grow when
IProcessorProvider.discoverNextProcessor()
is called.
-
getDeletedUnits
Description copied from class:AbstractAnnotationProcessorManager
Returns the deleted units.- Specified by:
getDeletedUnits
in classAbstractAnnotationProcessorManager
- Returns:
- the deleted units
-
getNewUnits
Description copied from class:AbstractAnnotationProcessorManager
Return the new units created in the last round.- Specified by:
getNewUnits
in classAbstractAnnotationProcessorManager
- Returns:
- the new units created in the last round
-
getNewClassFiles
Description copied from class:AbstractAnnotationProcessorManager
Return the new binary bindings created in the last round.- Specified by:
getNewClassFiles
in classAbstractAnnotationProcessorManager
- Returns:
- the new binary bindings created in the last round
-
reset
public void reset()Description copied from class:AbstractAnnotationProcessorManager
Reinitialize the receiver- Specified by:
reset
in classAbstractAnnotationProcessorManager
-
setErr
Description copied from class:AbstractAnnotationProcessorManager
Set the print writer for the standard error.- Specified by:
setErr
in classAbstractAnnotationProcessorManager
- Parameters:
err
- the given print writer for error
-
setOut
Description copied from class:AbstractAnnotationProcessorManager
Set the print writer for the standard output.- Specified by:
setOut
in classAbstractAnnotationProcessorManager
- Parameters:
out
- the given print writer for output
-
setProcessors
Description copied from class:AbstractAnnotationProcessorManager
Set the processors for annotation processing.- Specified by:
setProcessors
in classAbstractAnnotationProcessorManager
- Parameters:
processors
- the given processors
-
processAnnotations
public void processAnnotations(CompilationUnitDeclaration[] units, ReferenceBinding[] referenceBindings, boolean isLastRound) A single "round" of processing, in the sense implied inProcessor
.The Java 6 Processor spec contains ambiguities about how processors that support "*" are handled. Eclipse tries to match Sun's implementation in javac. What that actually does is analogous to inspecting the set of annotions found in the root units and adding an "imaginary" annotation if the set is empty. Processors are then called in order of discovery; for each processor, the intersection between the set of root annotations and the set of annotations the processor supports is calculated, and if it is non-empty, the processor is called. If the processor returns
true
then the intersection (including the imaginary annotation if one exists) is removed from the set of root annotations and the loop continues, until the set is empty. Of course, the imaginary annotation is not actually included in the set of annotations passed in to the processor. A processor's process() method is not called until its intersection set is non-empty, but thereafter it is called on every round. Note that even if a processor is not called in the first round, if it is called in subsequent rounds, it will be called in the order in which the processors were discovered, rather than being added to the end of the list.- Specified by:
processAnnotations
in classAbstractAnnotationProcessorManager
- Parameters:
units
- the given source typereferenceBindings
- the given binary typesisLastRound
- flag to notify the last round
-