org.glassfish.apf

Interface Scanner<T>

All Known Implementing Classes:

AppClientScanner, DirectoryScanner, EjbInWarScanner, EjbJarScanner, JarScanner, ModuleScanner, RarScanner, WarScanner

@Contract
public interface Scanner<T>

This interface is responsible for scanning the binary location provided and provide each binary file through a pull interfaces

Author:

Jerome Dochez

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader() Returns a ClassLoader capable of loading classes from the underlying medium
ComponentInfo	getComponentInfo(Class componentImpl) Sometimes, annotations processing requires more than a single class, especially when such classes end up being a Java Component (Java Beans, Java EE).
Set<Class>	getElements() Return a complete set of classes available from this location.
Set<Class>	getElements(Set<String> classNames) Return a class instance available from this location from class name.
org.glassfish.hk2.classmodel.reflect.Types	getTypes() Return the types information for this module
void	process(File archiveFile, T bundleDesc, ClassLoader classLoader) Scan the archive file and gather a list of classes that should be processed for annotations

Method Detail

process

void process(File archiveFile,
             T bundleDesc,
             ClassLoader classLoader)
      throws IOException

Scan the archive file and gather a list of classes that should be processed for annotations

Parameters:

archiveFile - the archive file for scanning

bundleDesc - the bundle descriptor associated with this archive

classLoader - the classloader used to scan the annotation

Throws:

IOException

getClassLoader

ClassLoader getClassLoader()

Returns a ClassLoader capable of loading classes from the underlying medium

Returns:

a class loader capable of loading the classes

getElements

Set<Class> getElements()

Return a complete set of classes available from this location.

Returns:

the complete set of classes

getElements

Set<Class> getElements(Set<String> classNames)

Return a class instance available from this location from class name.

Parameters:

classNames - the list of class name

Returns:

the set of classes for given names

getComponentInfo

ComponentInfo getComponentInfo(Class componentImpl)

Sometimes, annotations processing requires more than a single class, especially when such classes end up being a Java Component (Java Beans, Java EE). The implementation returned from the getComponent will be responsible for defining the complete view of this component starting from it's implementation class.

Parameters:

componentImpl - class of the component.

getTypes

org.glassfish.hk2.classmodel.reflect.Types getTypes()

Return the types information for this module

Returns:

types the archive resulting types