com.peterphi.std.guice.common

Class ClassScanner

java.lang.Object

com.peterphi.std.guice.common.ClassScanner

public class ClassScanner
extends Object

Constructor Summary

Constructors

Constructor and Description
ClassScanner(org.apache.xbean.finder.AnnotationFinder finder, long constructionTime) Construct a new ClassScanner wrapper around an AnnotationFinder

Method Summary

Modifier and Type	Method and Description
static com.google.common.base.Predicate<Class<?>>	annotatedWith(Class<? extends Annotation> annotation)
List<Class<?>>	getAnnotatedClasses(Class<? extends Annotation> annotation)
List<Class<?>>	getAnnotatedClasses(Class<? extends Annotation> annotation, com.google.common.base.Predicate<Class<?>> predicate)
List<Class<?>>	getClasses(String pkg, boolean recursive) Find all the classes in a package
List<Class<?>>	getClasses(String pkg, boolean recursive, com.google.common.base.Predicate<Class<?>> predicate) Find all the classes in a package
long	getConstructionTime()
<T> List<Class<? extends T>>	getImplementations(Class<T> clazz) Find all implementations of an interface (if an interface is provided) or extensions (if a class is provided)
<T> List<Class<? extends T>>	getImplementations(Class<T> clazz, com.google.common.base.Predicate<Class<? extends T>> predicate) Find filtered implementations of an interface (if an interface is provided) or extensions (if a class is provided)
List<Class<?>>	getInheritedAnnotatedClasses(Class<? extends Annotation> annotation)
List<Class<?>>	getInheritedAnnotatedClasses(Class<? extends Annotation> annotation, com.google.common.base.Predicate<Class<?>> predicate)
long	getSearchTime()
List<Class<?>>	getSiblingClasses(Class<?> clazz, boolean recursive, com.google.common.base.Predicate<Class<?>> predicate) Find all the classes that are siblings of the provided class
static com.google.common.base.Predicate<Class<?>>	interfaceClass()
static com.google.common.base.Predicate<Class<?>>	packagePredicate(com.google.common.base.Predicate<String> packagePredicate)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassScanner

public ClassScanner(org.apache.xbean.finder.AnnotationFinder finder,
                    long constructionTime)

Construct a new ClassScanner wrapper around an AnnotationFinder

Parameters:

finder - the xbeans-finder instance to use for searches

constructionTime - the time (in ms) taken to construct the associated AnnotationFinder instance (to expose for timing data)

Method Detail

getConstructionTime

public long getConstructionTime()

getSearchTime

public long getSearchTime()

getClasses

public List<Class<?>> getClasses(String pkg,
                                 boolean recursive,
                                 com.google.common.base.Predicate<Class<?>> predicate)

Find all the classes in a package

Parameters:

pkg -

recursive -

predicate - an optional additional predicate to filter the list against

Returns:

getClasses

public List<Class<?>> getClasses(String pkg,
                                 boolean recursive)

Find all the classes in a package

Parameters:

pkg -

recursive -

Returns:

getSiblingClasses

public List<Class<?>> getSiblingClasses(Class<?> clazz,
                                        boolean recursive,
                                        com.google.common.base.Predicate<Class<?>> predicate)

Find all the classes that are siblings of the provided class

Parameters:

clazz - the class in whose package to search

recursive - if true, search all the child packages of the package containing the class

predicate - an optional additional predicate to filter the list against

Returns:

getAnnotatedClasses

public List<Class<?>> getAnnotatedClasses(Class<? extends Annotation> annotation,
                                          com.google.common.base.Predicate<Class<?>> predicate)

getAnnotatedClasses

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

getInheritedAnnotatedClasses

public List<Class<?>> getInheritedAnnotatedClasses(Class<? extends Annotation> annotation,
                                                   com.google.common.base.Predicate<Class<?>> predicate)

getInheritedAnnotatedClasses

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

getImplementations

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

Find all implementations of an interface (if an interface is provided) or extensions (if a class is provided)

Type Parameters:

T -

Parameters:

clazz -

Returns:

getImplementations

public <T> List<Class<? extends T>> getImplementations(Class<T> clazz,
                                                       com.google.common.base.Predicate<Class<? extends T>> predicate)

Find filtered implementations of an interface (if an interface is provided) or extensions (if a class is provided)

Type Parameters:

T -

Parameters:

clazz -

predicate - the predicate to use to filter the implementations

Returns:

annotatedWith

public static com.google.common.base.Predicate<Class<?>> annotatedWith(Class<? extends Annotation> annotation)

packagePredicate

public static com.google.common.base.Predicate<Class<?>> packagePredicate(com.google.common.base.Predicate<String> packagePredicate)

interfaceClass

public static com.google.common.base.Predicate<Class<?>> interfaceClass()