xapi.dev.scanner.api

Interface ClasspathScanner

All Known Implementing Classes:

ClasspathScannerDefault

public interface ClasspathScanner

Most runtime annotation scanner libraries are too heavyweight; they try to do too much. Though great tools, we want flyweight and fast. This service is based on org.reflections:reflections, except we are doing much less, and using an api that will enable multi-threaded scanning, using a work-stealing algorithm to fill in a PackageTrie.

Author:

"James X. Nelson (james@wetheinter.net)"

Method Summary

Modifier and Type	Method and Description
ClasspathScanner	matchClassFile(String regex)
ClasspathScanner	matchClassFiles(String... regex)
ClasspathScanner	matchResource(String regex)
ClasspathScanner	matchResources(String... regex)
ClasspathScanner	matchSourceFile(String regex)
ClasspathScanner	matchSourceFiles(String... regex)
ExecutorService	newExecutor()
ClasspathResourceMap	scan(ClassLoader loader)
Callable<ClasspathResourceMap>	scan(ClassLoader loader, ExecutorService executor)
ClasspathScanner	scanAnnotation(Class<? extends Annotation> annotations)
ClasspathScanner	scanAnnotations(Class<? extends Annotation>... annotations)
ClasspathScanner	scanPackage(String pkg)
ClasspathScanner	scanPackages(String... pkgs)

Method Detail

scanPackage

ClasspathScanner scanPackage(String pkg)

scanPackages

ClasspathScanner scanPackages(String... pkgs)

scanAnnotation

ClasspathScanner scanAnnotation(Class<? extends Annotation> annotations)

scanAnnotations

ClasspathScanner scanAnnotations(Class<? extends Annotation>... annotations)

matchClassFile

ClasspathScanner matchClassFile(String regex)

matchClassFiles

ClasspathScanner matchClassFiles(String... regex)

matchSourceFile

ClasspathScanner matchSourceFile(String regex)

matchSourceFiles

ClasspathScanner matchSourceFiles(String... regex)

matchResource

ClasspathScanner matchResource(String regex)

matchResources

ClasspathScanner matchResources(String... regex)

scan

ClasspathResourceMap scan(ClassLoader loader)

scan

Callable<ClasspathResourceMap> scan(ClassLoader loader,
                                    ExecutorService executor)

newExecutor

ExecutorService newExecutor()