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.ClasspathScannerImpl

All Implemented Interfaces:

ClasspathScanner

@Named
public class ClasspathScannerImpl
extends AbstractLoggableComponent
implements ClasspathScanner

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.AbstractBrowsableClasspathResource Abstract base implementation of BrowsableResource for ClasspathScannerImpl.ClasspathFile or ClasspathScannerImpl.ClasspathFolder.
protected static class	ClasspathScannerImpl.Cache Container with all cached data.
protected static class	ClasspathScannerImpl.ClasspathFile A file on the classpath.
protected static class	ClasspathScannerImpl.ClasspathFolder A folder (package) of the classpath.

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 ClasspathScannerImpl.ClasspathFolder	createFolderRecursive(ResourcePathNode<Void> path, ClasspathScannerImpl.ClasspathFolder rootFolder)
protected ClasspathScannerImpl.Cache	getCache()
ClasspathScannerImpl.ClasspathFolder	getClasspathResource()
BrowsableResource	getClasspathResource(Package pkg)
BrowsableResource	getClasspathResource(String classpath)
Iterable<? extends BrowsableResource>	getClasspathResourceFiles()
Iterable<? extends BrowsableResource>	getClasspathResourceFiles(Filter<? super BrowsableResource> filter)
ReflectionUtil	getReflectionUtil()
private void	initCache() Scans the entire classpath and initializes the root.
void	setReflectionUtil(ReflectionUtil reflectionUtil)

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

createLogger, doInitialize, getLogger

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

doInitialized, 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

See Also:

getReflectionUtil()

cache

private ClasspathScannerImpl.Cache cache

See Also:

getCache()

Constructor Detail

ClasspathScannerImpl

public ClasspathScannerImpl()

The constructor.

Method Detail

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()

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.

Specified by:

clearCaches in interface ClasspathScanner

createFolderRecursive

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

Parameters:

path - the path to create.

rootFolder - the root folder.

Returns:

the folder for the given path.

getClasspathResource

public ClasspathScannerImpl.ClasspathFolder getClasspathResource()

Specified by:

getClasspathResource in interface ClasspathScanner

Returns:

the BrowsableResource for the root (or default) package.

getClasspathResource

public BrowsableResource getClasspathResource(String classpath)

Specified by:

getClasspathResource in interface ClasspathScanner

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)

Specified by:

getClasspathResource in interface ClasspathScanner

Parameters:

pkg - is the Package to get.

Returns:

the BrowsableResource pointing to the given package.

getClasspathResourceFiles

public Iterable<? extends BrowsableResource> getClasspathResourceFiles()

Specified by:

getClasspathResourceFiles in interface ClasspathScanner

Returns:

an Iterable with ALL existing file resources on the classpath.

getClasspathResourceFiles

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

Specified by:

getClasspathResourceFiles in interface ClasspathScanner

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.

getReflectionUtil

public ReflectionUtil getReflectionUtil()

Returns:

the ReflectionUtil to use.

setReflectionUtil

@Inject
public void setReflectionUtil(ReflectionUtil reflectionUtil)

Parameters:

reflectionUtil - is the ReflectionUtil to Inject.