FileDocCategorySizeDatePackage
AnnotationProcessor.javaAPI DocGlassfish v2 API6298Fri May 04 22:30:20 BST 2007com.sun.enterprise.deployment.annotation

AnnotationProcessor

public interface AnnotationProcessor

The annotation processor is the core engine to process annotations. All the processing configuration (input classes, error handlers, etc...) is provided by the ProcessingContext which can be either created from the createContext method or through another mean. Once the ProcessingContext has been initialized, it is passed to the process(ProcessingContext ctx) method which triggers the annotation processing.

Each class accessible from the ProcessingContext.getInputScanner instance, will be scanned for annotations. Each annotation will then be processed by invoking the corresponding AnnotationHandler from its annotation type.

The AnnotationProcessor can be configured by using the pushAnnotationHandler and popAnnotationHandler which allow new AnnotationHandler instances to be registered and unregistered for a particular annotation type.

Even without reconfiguring the AnnotationProcessor instance with the above configuration methods, the AnnotationProcessor implementation cannot guarantee to be thread safe, therefore, it is encouraged the make instanciation cheap and users should not use the same instance concurrently.

author
Jerome Dochez

Fields Summary
Constructors Summary
Methods Summary
public ProcessingContextcreateContext()
Creates a new empty ProcessingContext instance which can be configured before invoking the process() method.

return
an empty ProcessingContext

public AnnotationHandlergetAnnotationHandler(java.lang.Class type)

return
the top annotation handler for a particular annotation type
param
type the annotation type

public java.lang.reflect.AnnotatedElementgetLastAnnotatedElement(java.lang.annotation.ElementType type)

return
the most recent AnnotatedElement being processed which type is of the given ElementType or null if there is no such element in the stack of processed annotation elements.

public voidlog(java.util.logging.Level level, AnnotationInfo locator, java.lang.String localizedMessage)
Log a message on the default logger

public voidpopAnnotationHandler(java.lang.Class type)
Unregisters the last annotation handler registered for an annotation type.

param
type the annotation type.

public ProcessingResultprocess(ProcessingContext ctx)
Starts the annotation processing tool passing the processing context which encapuslate all information necessary for the configuration of the tool.

param
ctx is the initialized processing context
return
the result of the annoations processing

public ProcessingResultprocess(ProcessingContext ctx, java.lang.Class[] classes)
Process a set of classes from the parameter list rather than from the processing context. This allow the annotation handlers to call be the annotation processing tool when classes need to be processed in a particular context rather than when they are picked up by the scanner.

param
the processing context
param
the list of classes to process
return
the processing result for such classes
throws
AnnotationProcessorException if handlers fail to process an annotation

public voidpushAnnotationHandler(AnnotationHandler handler)
Registers a new AnnotationHandler for a particular annotation type. New annotation handler are pushed on a List of annotation handlers for that particular annotation type, the last annotation handler to be registered will be invoked first and so on. The annotation type handled by the AnnotationHandler instance is defined by the getAnnotationType() method of the AnnotationHandler instance

param
type the annotation type
param
handler the annotation handler instance