org.apache.xbean.finder
Class ClassFinder

java.lang.Object
  extended by org.apache.xbean.finder.ClassFinder

public class ClassFinder
extends java.lang.Object

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. The getClassesNotLoaded() method can be used immediately after any find* method to get a list of classes which matched the find requirements (i.e. contained the annotation), but were unable to be loaded.

Version:
$Rev: 731945 $ $Date: 2009-01-06 15:19:28 +0100 (Di, 06. Jan 2009) $
Author:
David Blevins

Nested Class Summary
 class ClassFinder.Annotatable
           
 class ClassFinder.AnnotationInfo
           
 class ClassFinder.ClassInfo
           
 class ClassFinder.FieldInfo
           
static interface ClassFinder.Info
           
 class ClassFinder.InfoBuildingVisitor
           
 class ClassFinder.MethodInfo
           
 class ClassFinder.PackageInfo
           
 
Constructor Summary
ClassFinder(java.lang.Class... classes)
           
ClassFinder(java.lang.ClassLoader classLoader)
          Creates a ClassFinder that will search the urls in the specified classloader excluding the urls in the classloader's parent.
ClassFinder(java.lang.ClassLoader classLoader, boolean excludeParent)
          Creates a ClassFinder that will search the urls in the specified classloader.
ClassFinder(java.lang.ClassLoader classLoader, java.lang.ClassLoader exclude)
          Creates a ClassFinder that will search the urls in the specified classloader excluding the urls in the 'exclude' classloader.
ClassFinder(java.lang.ClassLoader classLoader, java.util.Collection<java.net.URL> urls)
           
ClassFinder(java.lang.ClassLoader classLoader, java.net.URL url)
           
ClassFinder(java.util.List<java.lang.Class> classes)
           
 
Method Summary
 java.util.List<java.lang.Class> findAnnotatedClasses(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
           
 java.util.List<java.lang.reflect.Constructor> findAnnotatedConstructors(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
           
 java.util.List<java.lang.reflect.Field> findAnnotatedFields(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
           
 java.util.List<java.lang.reflect.Method> findAnnotatedMethods(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
           
 java.util.List<java.lang.Package> findAnnotatedPackages(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
           
 java.util.List<java.lang.Class> findClassesInPackage(java.lang.String packageName, boolean recursive)
           
 java.util.List<java.lang.Class> findInheritedAnnotatedClasses(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
          Naive implementation - works extremelly slow O(n^3)
 java.util.List<java.lang.String> getClassesNotLoaded()
          Returns a list of classes that could not be loaded in last invoked findAnnotated* method.
 boolean isAnnotationPresent(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClassFinder

public ClassFinder(java.lang.ClassLoader classLoader)
            throws java.lang.Exception
Creates a ClassFinder that will search the urls in the specified classloader excluding the urls in the classloader's parent. To include the parent classloader, use: new ClassFinder(classLoader, false); To exclude the parent's parent, use: new ClassFinder(classLoader, classLoader.getParent().getParent());

Parameters:
classLoader - source of classes to scan
Throws:
java.lang.Exception - if something goes wrong

ClassFinder

public ClassFinder(java.lang.ClassLoader classLoader,
                   boolean excludeParent)
            throws java.lang.Exception
Creates a ClassFinder that will search the urls in the specified classloader.

Parameters:
classLoader - source of classes to scan
excludeParent - Allegedly excludes classes from parent classloader, whatever that might mean
Throws:
java.lang.Exception - if something goes wrong.

ClassFinder

public ClassFinder(java.lang.ClassLoader classLoader,
                   java.lang.ClassLoader exclude)
            throws java.lang.Exception
Creates a ClassFinder that will search the urls in the specified classloader excluding the urls in the 'exclude' classloader.

Parameters:
classLoader - source of classes to scan
exclude - source of classes to exclude from scanning
Throws:
java.lang.Exception - if something goes wrong

ClassFinder

public ClassFinder(java.lang.ClassLoader classLoader,
                   java.net.URL url)

ClassFinder

public ClassFinder(java.lang.ClassLoader classLoader,
                   java.util.Collection<java.net.URL> urls)

ClassFinder

public ClassFinder(java.lang.Class... classes)

ClassFinder

public ClassFinder(java.util.List<java.lang.Class> classes)
Method Detail

isAnnotationPresent

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

getClassesNotLoaded

public java.util.List<java.lang.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.

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

findAnnotatedPackages

public java.util.List<java.lang.Package> findAnnotatedPackages(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

findAnnotatedClasses

public java.util.List<java.lang.Class> findAnnotatedClasses(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

findInheritedAnnotatedClasses

public java.util.List<java.lang.Class> findInheritedAnnotatedClasses(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
Naive implementation - works extremelly slow O(n^3)

Parameters:
annotation -
Returns:
list of directly or indirectly (inherited) annotated classes

findAnnotatedMethods

public java.util.List<java.lang.reflect.Method> findAnnotatedMethods(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

findAnnotatedConstructors

public java.util.List<java.lang.reflect.Constructor> findAnnotatedConstructors(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

findAnnotatedFields

public java.util.List<java.lang.reflect.Field> findAnnotatedFields(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

findClassesInPackage

public java.util.List<java.lang.Class> findClassesInPackage(java.lang.String packageName,
                                                            boolean recursive)