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

ProcessingContext

public interface ProcessingContext
This interface defines the context for the annotation procesing handler. There is only one context instance per AnnotationProcessor invocation.
author
Jerome Dochez

Fields Summary
Constructors Summary
Methods Summary
public ErrorHandlergetErrorHandler()
Return the error handler for this processing context.

return
the error handler

public AnnotatedElementHandlergetHandler()
Return the current handler (if any) receving all the annotated elements start and stop events.

return
the top handler

public UgetHandler(java.lang.Class handlerType)
Return the top handler casted to the requested handler type

param
requested handler type
return
the top handler
throws
ClassCastException if the top handler cannot be casted to the requested handler type.

public ScannergetProcessingInput()
Returns the Scanner implementation which is responsible for providing access to all the .class files the processing tool needs to scan.

return
scanner instance

public AnnotationProcessorgetProcessor()
Returns the AnnotationProcessor instance this context is associated with.

return
annotation processor instance

public AnnotatedElementHandlerpopHandler()
Removes the top handler

return
the removed handler

public voidpushHandler(AnnotatedElementHandler handler)
Push a new handler on the stack of handlers. This handler will receive all the AnnotedElementHandler events until it is removed from the stack with a popHandler() call.

param
handler the new events handler.

public voidsetErrorHandler(ErrorHandler errorHandler)
Sets the ErrorHandler instance for all errors/warnings that may be raised during the annotation processing.

param
handler the annotation handler

public voidsetProcessingInput(Scanner scanner)
Sets the Scanner implementation which is responsible for accessing all the .class files the AnnotationProcessor should process.