Top Description Fields Constructors Methods
com.sun.faces.config.manager.spi

public abstract Class AnnotationScanner

extends AnnotationProvider
Class Inheritance
Static Imports
com.sun.faces.config.WebConfiguration.WebContextInitParameter.AnnotationScanPackages, java.util.logging.Level.WARNING
This class is responsible for ensuring that the class file bytes of classes contained within the web application are scanned for any of the known Faces configuration Annotations:

Field Summary

Modifier and TypeField and Description
private Map<String, String[]>
classpathPackages

protected static final Set<Class<? extends Annotation>>
FACES_ANNOTATION_TYPE

protected static final Set<String>
FACES_ANNOTATIONS

private boolean
isAnnotationScanPackagesSet

private static final Logger
LOGGER

private String[]
webInfClassesPackages

private static final String
WILDCARD

Inherited from com.sun.faces.spi.AnnotationProvider:
servletContextwrappedAnnotationProvider

Constructor Summary

AccessConstructor and Description
public
AnnotationScanner(ServletContext
the ServletContext for the application to be scanned
sc)

Creates a new AnnotationScanner instance.

Method Summary

Modifier and TypeMethod and Description
protected Map<String, String[]>
getClasspathPackages()

protected String[]
getWebInfClassesPackages()

private void
initializeAnnotationScanPackages(ServletContext sc, WebConfiguration webConfig)

protected boolean
isAnnotationScanPackagesSet()

private String[]
normalizeJarPackages(String[] packages)

protected boolean

Returns:

true if the class should be processed further, otherwise, false
processClass(String
the class that should be processed
candidate)

protected boolean
processClass(String candidate, String[] packages)

protected Map<Class<? extends Annotation>, Set<Class<?>>>
processClassList(Set<String> classList)

protected boolean
processJar(String entry)

Inherited from com.sun.faces.spi.AnnotationProvider:
getAnnotatedClasses

Field Detail

classpathPackagesback to summary
private Map<String, String[]> classpathPackages
FACES_ANNOTATION_TYPEback to summary
protected static final Set<Class<? extends Annotation>> FACES_ANNOTATION_TYPE
FACES_ANNOTATIONSback to summary
protected static final Set<String> FACES_ANNOTATIONS
isAnnotationScanPackagesSetback to summary
private boolean isAnnotationScanPackagesSet
LOGGERback to summary
private static final Logger LOGGER
webInfClassesPackagesback to summary
private String[] webInfClassesPackages
WILDCARDback to summary
private static final String WILDCARD

Constructor Detail

AnnotationScannerback to summary
public AnnotationScanner(ServletContext sc)

Creates a new AnnotationScanner instance.

Parameters
sc:ServletContext

the ServletContext for the application to be scanned

Method Detail

getClasspathPackagesback to summary
protected Map<String, String[]> getClasspathPackages()
getWebInfClassesPackagesback to summary
protected String[] getWebInfClassesPackages()
initializeAnnotationScanPackagesback to summary
private void initializeAnnotationScanPackages(ServletContext sc, WebConfiguration webConfig)
isAnnotationScanPackagesSetback to summary
protected boolean isAnnotationScanPackagesSet()
normalizeJarPackagesback to summary
private String[] normalizeJarPackages(String[] packages)
processClassback to summary
protected boolean processClass(String candidate)
Parameters
candidate:String

the class that should be processed

Returns:boolean

true if the class should be processed further, otherwise, false

processClassback to summary
protected boolean processClass(String candidate, String[] packages)
processClassListback to summary
protected Map<Class<? extends Annotation>, Set<Class<?>>> processClassList(Set<String> classList)
processJarback to summary
protected boolean processJar(String entry)