net.sf.mmm.util.resource.impl

Class ClasspathScannerImpl

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.resource.impl.AbstractClasspathScanner

net.sf.mmm.util.resource.impl.ClasspathScannerImpl

All Implemented Interfaces:

ClasspathScanner

public class ClasspathScannerImpl
extends AbstractClasspathScanner

Implementation of ClasspathScanner.

Since:

7.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ClasspathScannerImpl.Cache Container with all cached data.

Field Summary

Fields

Modifier and Type	Field and Description
private ClasspathScannerImpl.Cache	cache
private ReflectionUtil	reflectionUtil

Constructor Summary

Constructors

Constructor and Description
ClasspathScannerImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
void	clearCaches() Evicts all cache data so that any further invocation of the other methods will rebuild the cached data from scratch.
private ClasspathFolder	createFolderRecursive(ResourcePathNode<Void> path, ClasspathFolder rootFolder)
protected void	doInitialize() This method performs the actual initialization.
protected ClasspathScannerImpl.Cache	getCache()
ClasspathFolder	getClasspathResource()
BrowsableResource	getClasspathResource(Package pkg)
BrowsableResource	getClasspathResource(String classpath)
Iterable<Class<?>>	getClasspathResourceClasses(Filter<String> classnameFilter, Filter<Class<?>> classFilter)
Iterable<? extends BrowsableResource>	getClasspathResourceFiles()
Iterable<? extends BrowsableResource>	getClasspathResourceFiles(Filter<? super BrowsableResource> filter)
String	getQualifiedName(DataResource classResource)
ReflectionUtil	getReflectionUtil()
private void	initCache() Scans the entire classpath and initializes the root.
<T> Class<T>	loadClass(BrowsableResource classResource)
void	setReflectionUtil(ReflectionUtil reflectionUtil)

Methods inherited from class net.sf.mmm.util.resource.impl.AbstractClasspathScanner

doInitialized, getInstance

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

reflectionUtil

private ReflectionUtil reflectionUtil

cache

private ClasspathScannerImpl.Cache cache

Constructor Detail

ClasspathScannerImpl

public ClasspathScannerImpl()

The constructor.

Method Detail

getReflectionUtil

public ReflectionUtil getReflectionUtil()

Returns:

the ReflectionUtil to use.

setReflectionUtil

@Inject
public void setReflectionUtil(ReflectionUtil reflectionUtil)

Parameters:

reflectionUtil - is the ReflectionUtil to Inject.

doInitialize

protected void doInitialize()

Description copied from class: AbstractComponent

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

getCache

protected final ClasspathScannerImpl.Cache getCache()

Returns:

the ClasspathScannerImpl.Cache. Will be created lazily.

initCache

private void initCache()

Scans the entire classpath and initializes the root.

clearCaches

public void clearCaches()

Description copied from interface: ClasspathScanner

Evicts all cache data so that any further invocation of the other methods will rebuild the cached data from scratch.
ATTENTION:
Using this method can be very expensive for subsequent calls. A regular Java application has a static classpath so this method does not make any sense. Only use this method if you have dynamic class-loaders and you are fully aware of performance implications.

createFolderRecursive

private ClasspathFolder createFolderRecursive(ResourcePathNode<Void> path,
                                              ClasspathFolder rootFolder)

Parameters:

path - the path to create.

rootFolder - the root folder.

Returns:

the folder for the given path.

getClasspathResource

public ClasspathFolder getClasspathResource()

Returns:

the BrowsableResource for the root (or default) package.

getClasspathResource

public BrowsableResource getClasspathResource(String classpath)

Parameters:

classpath - is the classpath location pointing to a Package or ClasspathResource.

Returns:

the BrowsableResource for the given classpath.

getClasspathResource

public BrowsableResource getClasspathResource(Package pkg)

Parameters:

pkg - is the Package to get.

Returns:

the BrowsableResource pointing to the given package.

getClasspathResourceFiles

public Iterable<? extends BrowsableResource> getClasspathResourceFiles()

Returns:

an Iterable with ALL existing file resources on the classpath.

getClasspathResourceFiles

public Iterable<? extends BrowsableResource> getClasspathResourceFiles(Filter<? super BrowsableResource> filter)

Parameters:

filter - decides which file resources to accept. Please note that the name of the filtered resources will end with ".class" in case of a Class.

Returns:

an Iterable with all resource files on the classpath accepted by the given filter.

getClasspathResourceClasses

public Iterable<Class<?>> getClasspathResourceClasses(Filter<String> classnameFilter,
                                                      Filter<Class<?>> classFilter)

Parameters:

classnameFilter - a Filter used to filter by qualified classname (to prevent unnecessary classloading).

classFilter - a Filter used to filter the Classes that have passed the classnameFilter and should be returned.

Returns:

an Iterable with the accepted classes.

getQualifiedName

public String getQualifiedName(DataResource classResource)
                        throws IllegalArgumentException

Parameters:

classResource - a DataResource that identifies a Java *.class file or a Package from your classpath. Should be retrieved from this ClasspathScanner.

Returns:

the corresponding qualified class name or package name. Will be null in case the given DataResource is not pointing to a Class or Package.

Throws:

IllegalArgumentException

loadClass

public <T> Class<T> loadClass(BrowsableResource classResource)
                       throws IllegalArgumentException

Type Parameters:

T - the generic type of the returned Class for simplistic usage.

Parameters:

classResource - a BrowsableResource that identifies a Java *.class file from your classpath. Should be retrieved from this ClasspathScanner.

Returns:

the loaded Class.

Throws:

IllegalArgumentException - if the given BrowsableResource does not point to a *.class file.