Index (GlassFish Java EE Annotation Framework 4.1.1 API)

A C D E F G H I J L O P R S T V W

A

add(ProcessingResult) - Method in class org.glassfish.apf.impl.ProcessingResultImpl
add(AnnotatedElement, HandlerProcessingResult) - Method in class org.glassfish.apf.impl.ProcessingResultImpl
addAll(HandlerProcessingResult) - Method in class org.glassfish.apf.impl.HandlerProcessingResultImpl
addResult(Class<? extends Annotation>, ResultType) - Method in class org.glassfish.apf.impl.HandlerProcessingResultImpl
AnnotatedElementHandler - Interface in org.glassfish.apf: Provides notification when the annotation processor is visiting a new AnnotatedElement.
ANNOTATION_HANDLER_METADATA - Static variable in interface org.glassfish.apf.AnnotationHandler
AnnotationContext - Class in org.glassfish.apf.context: Convenient superclass implementation of Context objects responsible for holding references to the DOL objects
AnnotationContext() - Constructor for class org.glassfish.apf.context.AnnotationContext: Creates a new instance of AnnotationContext
AnnotationHandler - Interface in org.glassfish.apf: This interface defines the contract for annotation handlers and the annotation processing engine.
AnnotationHandlerFor - Annotation Type in org.glassfish.apf: Normally goes with Service annotation, and this annotation must be placed on a class that implements AnnotationHandler.
AnnotationInfo - Class in org.glassfish.apf: Instances encapsulate all information necessary for an AnnotationHandler to process an annotation.
AnnotationInfo(ProcessingContext, AnnotatedElement, Annotation, ElementType) - Constructor for class org.glassfish.apf.AnnotationInfo: Creates a new instance of AnnotationInfo with all the information necessary to process an annotation.
AnnotationProcessor - Interface in org.glassfish.apf: The annotation processor is the core engine to process annotations.
AnnotationProcessorException - Exception in org.glassfish.apf: Exception that denotes a warning or error condition in the annotation procesing tool
AnnotationProcessorException(String) - Constructor for exception org.glassfish.apf.AnnotationProcessorException: Creats a new annotation exception
AnnotationProcessorException(String, AnnotationInfo) - Constructor for exception org.glassfish.apf.AnnotationProcessorException: Creates a new annotation exception
AnnotationProcessorImpl - Class in org.glassfish.apf.impl
AnnotationProcessorImpl() - Constructor for class org.glassfish.apf.impl.AnnotationProcessorImpl: Creates a new instance of AnnotationProcessorImpl
AnnotationUtils - Class in org.glassfish.apf.impl: Bag for utility methods
AnnotationUtils() - Constructor for class org.glassfish.apf.impl.AnnotationUtils

C

ComponentDefinition - Class in org.glassfish.apf.impl: This class represents the view of a class from annotation.
ComponentDefinition(Class) - Constructor for class org.glassfish.apf.impl.ComponentDefinition
ComponentInfo - Interface in org.glassfish.apf: This class encapsulates information about a component (usually a Java EE component).
createContext() - Method in interface org.glassfish.apf.AnnotationProcessor: Creates a new empty ProcessingContext instance which can be configured before invoking the process() method.
createContext() - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl

D

DefaultErrorHandler - Class in org.glassfish.apf.impl: Default implementation of the ErrorHandler
DefaultErrorHandler() - Constructor for class org.glassfish.apf.impl.DefaultErrorHandler: Creates a new ErrorHandler with the default logger
DefaultErrorHandler(Logger) - Constructor for class org.glassfish.apf.impl.DefaultErrorHandler: Creates a new ErrorHandler with the provided looger;
DirectoryScanner - Class in org.glassfish.apf.impl: Implementation of the Scanner interface for a directory
DirectoryScanner() - Constructor for class org.glassfish.apf.impl.DirectoryScanner

E

endElement(ElementType, AnnotatedElement) - Method in interface org.glassfish.apf.AnnotatedElementHandler: After annotations for an annotated element are processed, the endElement is called with the annotated element value and its type
endElement(ElementType, AnnotatedElement) - Method in class org.glassfish.apf.context.AnnotationContext
error(AnnotationProcessorException) - Method in interface org.glassfish.apf.ErrorHandler: Receive notification of an error
error(AnnotationProcessorException) - Method in class org.glassfish.apf.impl.DefaultErrorHandler: Receive notification of an error
ErrorHandler - Interface in org.glassfish.apf: Basic interfaced for annotation processing warnings and errors

F

Factory - Class in org.glassfish.apf.factory: The Factory is responsible for initializing a ready to use AnnotationProcessor.
Factory() - Constructor for class org.glassfish.apf.factory.Factory: we do no Create new instances of Factory
fine(AnnotationProcessorException) - Method in interface org.glassfish.apf.ErrorHandler: Receive notication of a fine error message
fine(AnnotationProcessorException) - Method in class org.glassfish.apf.impl.DefaultErrorHandler: Receive notication of a fine error message

G

getAnnotatedElement() - Method in class org.glassfish.apf.AnnotationInfo
getAnnotation() - Method in class org.glassfish.apf.AnnotationInfo
getAnnotationHandler(Class<? extends Annotation>) - Method in interface org.glassfish.apf.AnnotationProcessor
getAnnotationHandler(Class<? extends Annotation>) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl
getAnnotationHandlerForDescriptor(ServiceLocator, Class<?>) - Static method in class org.glassfish.apf.impl.AnnotationUtils: Gets the annotation handler for the given class (without causing any of the annotation handlers to be classloaded)
getAnnotationType() - Method in interface org.glassfish.apf.AnnotationHandler
getArchive() - Method in interface org.glassfish.apf.ProcessingContext: Returns the module archive that can be used to load files/resources, that assist in the processing of annotations.
getClassLoader() - Method in class org.glassfish.apf.impl.DirectoryScanner
getClassLoader() - Method in class org.glassfish.apf.impl.JarScanner
getClassLoader() - Method in interface org.glassfish.apf.Scanner: Returns a ClassLoader capable of loading classes from the underlying medium
getComponentInfo(Class) - Method in class org.glassfish.apf.impl.JavaEEScanner
getComponentInfo(Class) - Method in interface org.glassfish.apf.Scanner: Sometimes, annotations processing requires more than a single class, especially when such classes end up being a Java Component (Java Beans, Java EE).
getConstructors() - Method in interface org.glassfish.apf.ComponentInfo
getConstructors() - Method in class org.glassfish.apf.impl.ComponentDefinition
getDefaultAnnotationProcessor() - Static method in class org.glassfish.apf.factory.Factory: Return a empty AnnotationProcessor with no annotation handlers registered
getDefaultResult(Class<? extends Annotation>, ResultType) - Static method in class org.glassfish.apf.impl.HandlerProcessingResultImpl
getElements() - Method in class org.glassfish.apf.impl.DirectoryScanner
getElements() - Method in class org.glassfish.apf.impl.JarScanner
getElements() - Method in interface org.glassfish.apf.Scanner: Return a complete set of classes available from this location.
getElementType() - Method in class org.glassfish.apf.AnnotationInfo
getEntries() - Method in class org.glassfish.apf.impl.DirectoryScanner
getErrorHandler() - Method in interface org.glassfish.apf.ProcessingContext: Return the error handler for this processing context.
getFields() - Method in interface org.glassfish.apf.ComponentInfo
getFields() - Method in class org.glassfish.apf.impl.ComponentDefinition
getHandler() - Method in interface org.glassfish.apf.ProcessingContext: Return the current handler (if any) receving all the annotated elements start and stop events.
getHandler(Class<U>) - Method in interface org.glassfish.apf.ProcessingContext: Return the top handler casted to the requested handler type
getLastAnnotatedElement(ElementType) - Method in interface org.glassfish.apf.AnnotationProcessor
getLastAnnotatedElement(ElementType) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl
getLocalString(String, String, Object...) - Static method in class org.glassfish.apf.impl.AnnotationUtils
getLocator() - Method in exception org.glassfish.apf.AnnotationProcessorException: Return information about the annotation and annotated element which caused the exception or null if it is not available.
getLogger() - Static method in class org.glassfish.apf.impl.AnnotationUtils
getLoggerTarget() - Static method in class org.glassfish.apf.impl.AnnotationUtils
getMessage() - Method in exception org.glassfish.apf.AnnotationProcessorException: Return a meaningful string explaining the exception cause
getMethods() - Method in interface org.glassfish.apf.ComponentInfo
getMethods() - Method in class org.glassfish.apf.impl.ComponentDefinition
getOverallResult() - Method in interface org.glassfish.apf.HandlerProcessingResult
getOverallResult() - Method in class org.glassfish.apf.impl.HandlerProcessingResultImpl
getOverallResult() - Method in class org.glassfish.apf.impl.ProcessingResultImpl
getOverallResult() - Method in interface org.glassfish.apf.ProcessingResult
getProcessingContext() - Method in class org.glassfish.apf.AnnotationInfo
getProcessingContext() - Method in class org.glassfish.apf.context.AnnotationContext
getProcessingInput() - Method in interface org.glassfish.apf.ProcessingContext: Returns the Scanner implementation which is responsible for providing access to all the .class files the processing tool needs to scan.
getProcessor() - Method in interface org.glassfish.apf.ProcessingContext: Returns the AnnotationProcessor instance this context is associated with.
getResults() - Method in class org.glassfish.apf.impl.ProcessingResultImpl
getResults() - Method in interface org.glassfish.apf.ProcessingResult
getStack() - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl
getTypeDependencies() - Method in interface org.glassfish.apf.AnnotationHandler
getTypes() - Method in class org.glassfish.apf.impl.JavaEEScanner
getTypes() - Method in interface org.glassfish.apf.Scanner: Return the types information for this module

H

HandlerProcessingResult - Interface in org.glassfish.apf: This interface defines the result of an annotation processing returned by an annotation handler.
HandlerProcessingResultImpl - Class in org.glassfish.apf.impl
HandlerProcessingResultImpl(Map<Class<? extends Annotation>, ResultType>) - Constructor for class org.glassfish.apf.impl.HandlerProcessingResultImpl: Creates a new instance of HandlerProcessingResultImpl
HandlerProcessingResultImpl() - Constructor for class org.glassfish.apf.impl.HandlerProcessingResultImpl

I

initTypes(File) - Method in class org.glassfish.apf.impl.JavaEEScanner
isFatal() - Method in exception org.glassfish.apf.AnnotationProcessorException
isSkipAnnotationProcessing(String) - Static method in class org.glassfish.apf.factory.Factory

J

JarScanner - Class in org.glassfish.apf.impl: Implements the scanner interface on a jar file.
JarScanner() - Constructor for class org.glassfish.apf.impl.JarScanner
JavaEEScanner - Class in org.glassfish.apf.impl: Super class for all JavaEE scanners
JavaEEScanner() - Constructor for class org.glassfish.apf.impl.JavaEEScanner

L

log(Level, AnnotationInfo, String) - Method in interface org.glassfish.apf.AnnotationProcessor: Log a message on the default logger
log(Level, AnnotationInfo, String) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl: Log a message on the default logger

O

org.glassfish.apf - package org.glassfish.apf: Provides the classes necessary to process J2SE 1.5 annotations in the context of the J2EE application server.
org.glassfish.apf.context - package org.glassfish.apf.context
org.glassfish.apf.factory - package org.glassfish.apf.factory
org.glassfish.apf.impl - package org.glassfish.apf.impl

P

popAnnotationHandler(Class<? extends Annotation>) - Method in interface org.glassfish.apf.AnnotationProcessor: Unregisters the last annotation handler registered for an annotation type.
popAnnotationHandler(Class<? extends Annotation>) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl
popHandler() - Method in interface org.glassfish.apf.ProcessingContext: Removes the top handler
process(ProcessingContext) - Method in interface org.glassfish.apf.AnnotationProcessor: Starts the annotation processing tool passing the processing context which encapuslate all information necessary for the configuration of the tool.
process(ProcessingContext, Class[]) - Method in interface org.glassfish.apf.AnnotationProcessor: Process a set of classes from the parameter list rather than from the processing context.
process(ProcessingContext) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl: Starts the annotation processing tool passing the processing context which encapuslate all information necessary for the configuration of the tool.
process(ProcessingContext, Class[]) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl: Process a set of classes from the parameter list rather than from the processing context.
process(File, Object, ClassLoader) - Method in class org.glassfish.apf.impl.DirectoryScanner
process(File, Object, ClassLoader) - Method in class org.glassfish.apf.impl.JarScanner
process(File, T, ClassLoader) - Method in interface org.glassfish.apf.Scanner: Scan the archive file and gather a list of classes that should be processed for anntoations
processAnnotation(AnnotationInfo) - Method in interface org.glassfish.apf.AnnotationHandler: Process a particular annotation which type is the same as the one returned by @see getAnnotationType().
processedAnnotations() - Method in interface org.glassfish.apf.HandlerProcessingResult: Returns a map of annotation types processed by this handler as keys and a ResultType as a value to communicate the result of the annotation processing for each processed annotation types.
processedAnnotations() - Method in class org.glassfish.apf.impl.HandlerProcessingResultImpl
ProcessingContext - Interface in org.glassfish.apf: This interface defines the context for the annotation procesing handler.
ProcessingResult - Interface in org.glassfish.apf: This interface encapsulates all AnnotatedElements processing result by the AnnotationProcessor tool.
ProcessingResultImpl - Class in org.glassfish.apf.impl: Implementation of the ProcessingResult interface
ProcessingResultImpl() - Constructor for class org.glassfish.apf.impl.ProcessingResultImpl: Creates a new instance of ProcessingResultImpl
pushAnnotationHandler(AnnotationHandler) - Method in interface org.glassfish.apf.AnnotationProcessor: Registers a new AnnotationHandler for a particular annotation type.
pushAnnotationHandler(AnnotationHandler) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl
pushAnnotationHandler(String, AnnotationHandler) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl: This method is similar to AnnotationProcessorImpl.pushAnnotationHandler(AnnotationHandler) except that it takes an additional String type argument which allows us to avoid extracting the information from the AnnotationHandler.
pushHandler(AnnotatedElementHandler) - Method in interface org.glassfish.apf.ProcessingContext: Push a new handler on the stack of handlers.

R

ResultType - Enum in org.glassfish.apf: Defines the result from a single annotation processing, UNPROCESSED mean the annotation has not been processed by any handler yet, PROCESSED mean that all processing had been done and the annotation was fully processed, FAILED indicate an error condition.

S

Scanner<T> - Interface in org.glassfish.apf: This interface is responsible for scanning the binary location provided and provide each binary file through a pull interfaces
setArchive(ReadableArchive) - Method in interface org.glassfish.apf.ProcessingContext
setDelegate(AnnotationProcessorImpl) - Method in class org.glassfish.apf.impl.AnnotationProcessorImpl
setErrorHandler(ErrorHandler) - Method in interface org.glassfish.apf.ProcessingContext: Sets the ErrorHandler instance for all errors/warnings that may be raised during the annotation processing.
setFatal(boolean) - Method in exception org.glassfish.apf.AnnotationProcessorException: Sets wether is exception is considered as fatal to the annotation processing.
setLogger(Logger) - Static method in class org.glassfish.apf.impl.AnnotationUtils
setLoggerTarget(String) - Static method in class org.glassfish.apf.impl.AnnotationUtils
setProcessingContext(ProcessingContext) - Method in class org.glassfish.apf.context.AnnotationContext
setProcessingInput(Scanner) - Method in interface org.glassfish.apf.ProcessingContext: Sets the Scanner implementation which is responsible for accessing all the .class files the AnnotationProcessor should process.
shouldLog(String) - Static method in class org.glassfish.apf.impl.AnnotationUtils
startElement(ElementType, AnnotatedElement) - Method in interface org.glassfish.apf.AnnotatedElementHandler: Before annotations for an annotated element are processed, the startElement is called with the annotated element value and its type
startElement(ElementType, AnnotatedElement) - Method in class org.glassfish.apf.context.AnnotationContext

T

toString() - Method in class org.glassfish.apf.AnnotationInfo
toString() - Method in exception org.glassfish.apf.AnnotationProcessorException

V

valueOf(String) - Static method in enum org.glassfish.apf.ResultType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.glassfish.apf.ResultType: Returns an array containing the constants of this enum type, in the order they are declared.

W

warning(AnnotationProcessorException) - Method in interface org.glassfish.apf.ErrorHandler: Receive notification of a warning
warning(AnnotationProcessorException) - Method in class org.glassfish.apf.impl.DefaultErrorHandler: Receive notification of a warning

A C D E F G H I J L O P R S T V W