Package org.apache.xbean.finder

Class AnnotationFinder

java.lang.Object

org.apache.xbean.finder.AnnotationFinder

All Implemented Interfaces:

IAnnotationFinder

public class AnnotationFinder
extends Object
implements IAnnotationFinder

ClassFinder searches the classpath of the specified classloader for packages, classes, constructors, methods, or fields with specific annotations.

For security reasons ASM is used to find the annotations. Classes are not loaded unless they match the requirements of a called findAnnotated* method. Once loaded, these classes are cached.

Version:

$Rev$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AnnotationFinder.Annotatable
class	AnnotationFinder.AnnotationInfo
class	AnnotationFinder.ClassInfo
class	AnnotationFinder.FieldInfo
static interface	AnnotationFinder.Info
class	AnnotationFinder.InfoBuildingVisitor
class	AnnotationFinder.MethodInfo
class	AnnotationFinder.PackageInfo
class	AnnotationFinder.ParameterInfo
class	AnnotationFinder.SubArchive

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	ALLOW_LAZY_LINKING
protected final Map<String,List<AnnotationFinder.Info>>	annotated
private final Archive	archive
private static final int	ASM_FLAGS
private final boolean	checkRuntimeAnnotation
private final List<String>	classesNotLoaded
protected final Map<String,AnnotationFinder.ClassInfo>	classInfos
private boolean	linking
private final Set<Class<? extends Annotation>>	metaroots
protected final Map<String,AnnotationFinder.ClassInfo>	originalInfos

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AnnotationFinder(AnnotationFinder parent, Iterable<String> classNames)
	AnnotationFinder(Archive archive)
	AnnotationFinder(Archive archive, boolean checkRuntimeAnnotation)

Method Summary

Modifier and Type	Method	Description
private <T> List<Class<? extends T>>	_findSubclasses(Class<T> clazz)
protected boolean	cleanOnNaked()
private List<AnnotationFinder.ClassInfo>	collectImplementations(String interfaceName)
AnnotationFinder	enableFindImplementations()
AnnotationFinder	enableFindSubclasses()
AnnotationFinder	enableMetaAnnotations()
List<Class<?>>	findAnnotatedClasses(Class<? extends Annotation> annotation)
List<Parameter<Constructor<?>>>	findAnnotatedConstructorParameters(Class<? extends Annotation> annotation)
List<Constructor>	findAnnotatedConstructors(Class<? extends Annotation> annotation)
List<Field>	findAnnotatedFields(Class<? extends Annotation> annotation)
List<Parameter<Method>>	findAnnotatedMethodParameters(Class<? extends Annotation> annotation)
List<Method>	findAnnotatedMethods(Class<? extends Annotation> annotation)
List<Package>	findAnnotatedPackages(Class<? extends Annotation> annotation)
List<Class<?>>	findClassesInPackage(String packageName, boolean recursive)
<T> List<Class<? extends T>>	findImplementations(Class<T> clazz)
List<Class<?>>	findInheritedAnnotatedClasses(Class<? extends Annotation> annotation)	Naive implementation - works extremelly slow O(n^3)
List<Annotated<Class<?>>>	findMetaAnnotatedClasses(Class<? extends Annotation> annotation)
private Set<Class<?>>	findMetaAnnotatedClasses(Class<? extends Annotation> annotation, Set<Class<?>> classes)
List<Annotated<Field>>	findMetaAnnotatedFields(Class<? extends Annotation> annotation)
private Set<Field>	findMetaAnnotatedFields(Class<? extends Annotation> annotation, Set<Field> fields, Set<String> seen)
List<Annotated<Method>>	findMetaAnnotatedMethods(Class<? extends Annotation> annotation)
private Set<Method>	findMetaAnnotatedMethods(Class<? extends Annotation> annotation, Set<Method> methods, Set<String> seen)
<T> List<Class<? extends T>>	findSubclasses(Class<T> clazz)
private <T> void	findSubclasses(AnnotationFinder.ClassInfo classInfo, List<Class<? extends T>> found, Class<T> clazz)
List<String>	getAnnotatedClassNames()
protected List<AnnotationFinder.Info>	getAnnotationInfos(String name)
Archive	getArchive()
List<String>	getClassesNotLoaded()	Returns a list of classes that could not be loaded in last invoked findAnnotated* method.
boolean	hasMetaAnnotations()
private boolean	hasName(String className, String simpleName)
private void	index(List<? extends AnnotationFinder.Info> infos)
private void	index(AnnotationFinder.AnnotationInfo annotationInfo, AnnotationFinder.Info info)
private void	index(AnnotationFinder.Info i)
protected List<AnnotationFinder.Info>	initAnnotationInfos(String name)
boolean	isAnnotationPresent(Class<? extends Annotation> annotation)
protected boolean	isJvm(String name)
private static boolean	isMetaAnnotation(Class<? extends Annotation> clazz)
private boolean	isMetaRoot(AnnotationFinder.ClassInfo classInfo)
private static boolean	isMetatypeAnnotation(Class<? extends Annotation> type)
private static boolean	isSelfAnnotated(Class<? extends Annotation> type, String name)
private boolean	isSelfAnnotated(AnnotationFinder.ClassInfo classInfo, String metatype)
protected boolean	isTracked(String annotationType)
AnnotationFinder	link()	The link() method must be called to successfully use the findSubclasses and findImplementations methods
protected void	linkInterfaces(AnnotationFinder.ClassInfo classInfo)
private void	linkMetaAnnotations()
protected void	linkParent(AnnotationFinder.ClassInfo classInfo)
protected Map<String,List<AnnotationFinder.Info>>	newAnnotatedMap()
protected Map<String,AnnotationFinder.ClassInfo>	newClassInfoMap()
protected void	readClassDef(Class clazz)
protected void	readClassDef(String className)
protected void	readClassDef(String className, InputStream in)
private void	readClassDef(AnnotationFinder.ClassInfo info)
private void	resolveAnnotations(List<String> scanned)	Used to support meta annotations
private void	resolveAnnotations(AnnotationFinder parent, List<String> scanned)
AnnotationFinder	select(Class<?>... clazz)
AnnotationFinder	select(Iterable<String> clazz)
AnnotationFinder	select(String... clazz)
private static boolean	validTarget(Class<? extends Annotation> type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ASM_FLAGS

private static final int ASM_FLAGS

See Also:

• Constant Field Values

ALLOW_LAZY_LINKING

private static final boolean ALLOW_LAZY_LINKING

metaroots

private final Set<Class<? extends Annotation>> metaroots

annotated

protected final Map<String,List<AnnotationFinder.Info>> annotated

classInfos

protected final Map<String,AnnotationFinder.ClassInfo> classInfos

originalInfos

protected final Map<String,AnnotationFinder.ClassInfo> originalInfos

classesNotLoaded

private final List<String> classesNotLoaded

archive

private final Archive archive

checkRuntimeAnnotation

private final boolean checkRuntimeAnnotation

linking

private volatile boolean linking

Constructor Details

AnnotationFinder

private AnnotationFinder(AnnotationFinder parent,
 Iterable<String> classNames)

AnnotationFinder

public AnnotationFinder(Archive archive,
 boolean checkRuntimeAnnotation)

Parameters:

archive -

checkRuntimeAnnotation - Has no effect on findMetaAnnotated* methods

AnnotationFinder

public AnnotationFinder(Archive archive)

Method Details

newAnnotatedMap

protected Map<String,List<AnnotationFinder.Info>> newAnnotatedMap()

newClassInfoMap

protected Map<String,AnnotationFinder.ClassInfo> newClassInfoMap()

cleanOnNaked

protected boolean cleanOnNaked()

isTracked

protected boolean isTracked(String annotationType)

hasMetaAnnotations

public boolean hasMetaAnnotations()

readClassDef

private void readClassDef(AnnotationFinder.ClassInfo info)

resolveAnnotations

private void resolveAnnotations(AnnotationFinder parent,
 List<String> scanned)

index

private void index(List<? extends AnnotationFinder.Info> infos)

index

private void index(AnnotationFinder.Info i)

getAnnotatedClassNames

public List<String> getAnnotatedClassNames()

Specified by:

getAnnotatedClassNames in interface IAnnotationFinder

getArchive

public Archive getArchive()

link

public AnnotationFinder link()

The link() method must be called to successfully use the findSubclasses and findImplementations methods

Returns:

Throws:

IOException

enableMetaAnnotations

public AnnotationFinder enableMetaAnnotations()

enableFindImplementations

public AnnotationFinder enableFindImplementations()

enableFindSubclasses

public AnnotationFinder enableFindSubclasses()

resolveAnnotations

private void resolveAnnotations(List<String> scanned)

Used to support meta annotations

Once the list of classes has been read from the Archive, we iterate over all the annotations that are used by those classes and recursively resolve any annotations those annotations use.

Parameters:

scanned -

Throws:

ClassNotFoundException

IOException

linkMetaAnnotations

private void linkMetaAnnotations()

isMetaRoot

private boolean isMetaRoot(AnnotationFinder.ClassInfo classInfo)

isSelfAnnotated

private boolean isSelfAnnotated(AnnotationFinder.ClassInfo classInfo,
 String metatype)

hasName

private boolean hasName(String className,
 String simpleName)

linkParent

protected void linkParent(AnnotationFinder.ClassInfo classInfo)

isJvm

protected boolean isJvm(String name)

linkInterfaces

protected void linkInterfaces(AnnotationFinder.ClassInfo classInfo)

isAnnotationPresent

public boolean isAnnotationPresent(Class<? extends Annotation> annotation)

Specified by:

isAnnotationPresent in interface IAnnotationFinder

getClassesNotLoaded

public List<String> getClassesNotLoaded()

Returns a list of classes that could not be loaded in last invoked findAnnotated* method.

The list will only contain entries of classes whose byte code matched the requirements of last invoked find* method, but were unable to be loaded and included in the results.

The list returned is unmodifiable. Once obtained, the returned list will be a live view of the results from the last findAnnotated* method call.

This method is not thread safe.

Specified by:

getClassesNotLoaded in interface IAnnotationFinder

Returns:

an unmodifiable live view of classes that could not be loaded in previous findAnnotated* call.

findAnnotatedPackages

public List<Package> findAnnotatedPackages(Class<? extends Annotation> annotation)

Specified by:

findAnnotatedPackages in interface IAnnotationFinder

findAnnotatedClasses

public List<Class<?>> findAnnotatedClasses(Class<? extends Annotation> annotation)

Specified by:

findAnnotatedClasses in interface IAnnotationFinder

findMetaAnnotatedClasses

public List<Annotated<Class<?>>> findMetaAnnotatedClasses(Class<? extends Annotation> annotation)

Specified by:

findMetaAnnotatedClasses in interface IAnnotationFinder

isMetaAnnotation

private static boolean isMetaAnnotation(Class<? extends Annotation> clazz)

isMetatypeAnnotation

private static boolean isMetatypeAnnotation(Class<? extends Annotation> type)

isSelfAnnotated

private static boolean isSelfAnnotated(Class<? extends Annotation> type,
 String name)

validTarget

private static boolean validTarget(Class<? extends Annotation> type)

findMetaAnnotatedClasses

private Set<Class<?>> findMetaAnnotatedClasses(Class<? extends Annotation> annotation,
 Set<Class<?>> classes)

findInheritedAnnotatedClasses

public List<Class<?>> findInheritedAnnotatedClasses(Class<? extends Annotation> annotation)

Naive implementation - works extremelly slow O(n^3)

Specified by:

findInheritedAnnotatedClasses in interface IAnnotationFinder

Parameters:

annotation -

Returns:

list of directly or indirectly (inherited) annotated classes

findAnnotatedMethods

public List<Method> findAnnotatedMethods(Class<? extends Annotation> annotation)

Specified by:

findAnnotatedMethods in interface IAnnotationFinder

findAnnotatedMethodParameters

public List<Parameter<Method>> findAnnotatedMethodParameters(Class<? extends Annotation> annotation)

findMetaAnnotatedMethods

public List<Annotated<Method>> findMetaAnnotatedMethods(Class<? extends Annotation> annotation)

Specified by:

findMetaAnnotatedMethods in interface IAnnotationFinder

findMetaAnnotatedMethods

private Set<Method> findMetaAnnotatedMethods(Class<? extends Annotation> annotation,
 Set<Method> methods,
 Set<String> seen)

findMetaAnnotatedFields

public List<Annotated<Field>> findMetaAnnotatedFields(Class<? extends Annotation> annotation)

Specified by:

findMetaAnnotatedFields in interface IAnnotationFinder

findMetaAnnotatedFields

private Set<Field> findMetaAnnotatedFields(Class<? extends Annotation> annotation,
 Set<Field> fields,
 Set<String> seen)

findAnnotatedConstructors

public List<Constructor> findAnnotatedConstructors(Class<? extends Annotation> annotation)

Specified by:

findAnnotatedConstructors in interface IAnnotationFinder

findAnnotatedConstructorParameters

public List<Parameter<Constructor<?>>> findAnnotatedConstructorParameters(Class<? extends Annotation> annotation)

findAnnotatedFields

public List<Field> findAnnotatedFields(Class<? extends Annotation> annotation)

Specified by:

findAnnotatedFields in interface IAnnotationFinder

findClassesInPackage

public List<Class<?>> findClassesInPackage(String packageName,
 boolean recursive)

Specified by:

findClassesInPackage in interface IAnnotationFinder

findSubclasses

public <T> List<Class<? extends T>> findSubclasses(Class<T> clazz)

Specified by:

findSubclasses in interface IAnnotationFinder

findSubclasses

private <T> void findSubclasses(AnnotationFinder.ClassInfo classInfo,
 List<Class<? extends T>> found,
 Class<T> clazz)

_findSubclasses

private <T> List<Class<? extends T>> _findSubclasses(Class<T> clazz)

findImplementations

public <T> List<Class<? extends T>> findImplementations(Class<T> clazz)

Specified by:

findImplementations in interface IAnnotationFinder

collectImplementations

private List<AnnotationFinder.ClassInfo> collectImplementations(String interfaceName)

getAnnotationInfos

protected List<AnnotationFinder.Info> getAnnotationInfos(String name)

initAnnotationInfos

protected List<AnnotationFinder.Info> initAnnotationInfos(String name)

readClassDef

protected void readClassDef(String className)

readClassDef

protected void readClassDef(String className,
 InputStream in)
                     throws IOException

Throws:

IOException

readClassDef

protected void readClassDef(Class clazz)

select

public AnnotationFinder select(Class<?>... clazz)

select

public AnnotationFinder select(String... clazz)

select

public AnnotationFinder select(Iterable<String> clazz)

index

private void index(AnnotationFinder.AnnotationInfo annotationInfo,
 AnnotationFinder.Info info)