org.xenei.classpathutils

Class ClassPathUtils

java.lang.Object

org.xenei.classpathutils.ClassPathUtils

public class ClassPathUtils
extends Object

Package of class path searching utilities

Constructor Summary

Constructors

Constructor and Description
ClassPathUtils()

Method Summary

Modifier and Type	Method and Description
static void	doLog(Object... args) Write to log if log is enabled.
static Set<Class<?>>	filterClasses(Collection<Class<?>> classes, ClassPathFilter filter) Return the set of classes from the collection that pass the filter.
static Set<String>	filterClassNames(Collection<String> classNames, ClassPathFilter filter) Return the set of classes from the collection that pass the filter.
static Set<String>	findClasses(String directory, String packageName) Recursive method used to find all classes in a given directory and subdirs.
static Set<String>	findClasses(String directory, String packageName, ClassPathFilter filter) Find the classes in a directory and sub directory.
static Set<String>	findResources(String directory, String packageName) Recursive method used to find all classes in a given directory and subdirs.
static Set<String>	findResources(String directory, String packageName, ClassPathFilter filter) Find the classes in a directory and sub directory.
static Set<Class<?>>	getAllInterfaces(Class<?> clazz) Get all the interfaces for the class.
static Set<Class<?>>	getAllInterfaces(Class<?> clazz, ClassPathFilter filter) Get all the interfaces for the class that meet the filter.
static void	getAllInterfaces(Set<Class<?>> set, Class<?> c) Get all the interfaces that the class implements.
static Collection<Class<?>>	getClasses(ClassLoader classLoader, String packageName) Find all classes accessible from the class loader which belong to the given package and sub packages.
static Collection<Class<?>>	getClasses(ClassLoader classLoader, String packageName, ClassPathFilter filter) Find all classes accessible from the class loader which belong to the given package and sub packages.
static Collection<Class<?>>	getClasses(String packageName) Find all classes accessible from the context class loader which belong to the given package and sub packages.
static Collection<Class<?>>	getClasses(String packageName, ClassPathFilter filter) Get a collection of classes in the package name that meet the filter.
static ClassLoader	getClassLoader() Get the classloader.
static String[]	getClassPathElements() Get the array of class path elements.
static Collection<URL>	getResources(ClassLoader classLoader, String packageName) Find all classes accessible from the class loader which belong to the given package and sub packages.
static Collection<URL>	getResources(ClassLoader classLoader, String packageName, ClassPathFilter filter) Find all classes accessible from the class loader which belong to the given package and sub packages.
static Collection<URL>	getResources(String packageName) Find all classes accessible from the context class loader which belong to the given package and sub packages.
static Collection<URL>	getResources(String packageName, ClassPathFilter filter) Get a collection of classes in the package name that meet the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathUtils

public ClassPathUtils()

Method Detail

doLog

public static void doLog(Object... args)

Write to log if log is enabled.

Parameters:

args -

getClassLoader

public static ClassLoader getClassLoader()

Get the classloader.

Returns:

The classloader to use for finding classes and resources.

findClasses

public static Set<String> findClasses(String directory,
                                      String packageName)
                               throws IOException

Recursive method used to find all classes in a given directory and subdirs. Adapted from http://snippets.dzone.com/posts/show/4831 and extended to support use of JAR files

Parameters:

directory - The base directory

packageName - The package name for classes found inside the base directory

Returns:

The classes

Throws:

IOException - on error.

findClasses

public static Set<String> findClasses(String directory,
                                      String packageName,
                                      ClassPathFilter filter)
                               throws IOException

Find the classes in a directory and sub directory.

Parameters:

directory - The directory or jar file to search.

packageName - The list of packages to look for.

filter - The filter to apply to results.

Returns:

list of class names that match the filter.

Throws:

IOException - on error.

getClasses

public static Collection<Class<?>> getClasses(String packageName)

Find all classes accessible from the context class loader which belong to the given package and sub packages. An empty or null packageName = all packages.

Parameters:

packageName - The base package or class name.

Returns:

A collection of Class objects.

getClasses

public static Collection<Class<?>> getClasses(String packageName,
                                              ClassPathFilter filter)

Get a collection of classes in the package name that meet the filter. Classes will be loaded from the current thread class loader.

Parameters:

packageName - The package name to locate.

filter - the ClassFilter to filter the results with.

Returns:

A collection of Class objects.

getClasses

public static Collection<Class<?>> getClasses(ClassLoader classLoader,
                                              String packageName)

Find all classes accessible from the class loader which belong to the given package and sub packages. Adapted from http://snippets.dzone.com/posts/show/4831 and extended to support use of JAR files

Parameters:

classLoader - The class loader to load the classes from.

packageName - The base package or class name

Returns:

A collection of Class objects

getClasses

public static Collection<Class<?>> getClasses(ClassLoader classLoader,
                                              String packageName,
                                              ClassPathFilter filter)

Find all classes accessible from the class loader which belong to the given package and sub packages. Adapted from http://snippets.dzone.com/posts/show/4831 and extended to support use of JAR files

Parameters:

classLoader - The class loader to load the classes from.

packageName - The package name to locate the classes in.

filter - The filter for the classes.

Returns:

A collection of Class objects

filterClasses

public static Set<Class<?>> filterClasses(Collection<Class<?>> classes,
                                          ClassPathFilter filter)

Return the set of classes from the collection that pass the filter.

Parameters:

classes - The collection of classes to filter.

filter - The filter to use.

Returns:

the set of Class objects that pass the filter.

filterClassNames

public static Set<String> filterClassNames(Collection<String> classNames,
                                           ClassPathFilter filter)

Return the set of classes from the collection that pass the filter.

Parameters:

classNames - the collection of class names.

filter - The filter to apply.

Returns:

the set of class names that pass the filter.

getClassPathElements

public static String[] getClassPathElements()

Get the array of class path elements. These are strings separated by java.class.path property

Returns:

Array of class path elements

getAllInterfaces

public static Set<Class<?>> getAllInterfaces(Class<?> clazz)

Get all the interfaces for the class.

Parameters:

clazz - The class to find interfaces for.

Returns:

set of interfaces implemented by clazz.

getAllInterfaces

public static Set<Class<?>> getAllInterfaces(Class<?> clazz,
                                             ClassPathFilter filter)

Get all the interfaces for the class that meet the filter.

Parameters:

clazz - The class to find interfaces for.

filter - The filter to apply.

Returns:

set of interfaces implemented by clazz.

getAllInterfaces

public static void getAllInterfaces(Set<Class<?>> set,
                                    Class<?> c)

Get all the interfaces that the class implements. Adds the interfaces to the set of classes. This method calls recursively to find all parent interfaces.

Parameters:

set - The set off classes to add the interface classes to.

c - The class to check.

findResources

public static Set<String> findResources(String directory,
                                        String packageName)
                                 throws IOException

Recursive method used to find all classes in a given directory and subdirs. Adapted from http://snippets.dzone.com/posts/show/4831 and extended to support use of JAR files

Parameters:

directory - The base directory

packageName - The package name for classes found inside the base directory

Returns:

The classes

Throws:

IOException - on error.

findResources

public static Set<String> findResources(String directory,
                                        String packageName,
                                        ClassPathFilter filter)
                                 throws IOException

Find the classes in a directory and sub directory.

Parameters:

directory - The directory or jar file to search.

packageName - The list of packages to look for.

filter - The filter to apply to results.

Returns:

list of class names that match the filter.

Throws:

IOException - on error.

getResources

public static Collection<URL> getResources(String packageName)

Find all classes accessible from the context class loader which belong to the given package and sub packages. An empty or null packageName = all packages.

Parameters:

packageName - The base package or class name.

Returns:

A collection of Class objects.

getResources

public static Collection<URL> getResources(String packageName,
                                           ClassPathFilter filter)

Get a collection of classes in the package name that meet the filter. Classes will be loaded from the current thread class loader.

Parameters:

packageName - The package name to locate.

filter - the ClassFilter to filter the results with.

Returns:

A collection of Class objects.

getResources

public static Collection<URL> getResources(ClassLoader classLoader,
                                           String packageName)

Find all classes accessible from the class loader which belong to the given package and sub packages. Adapted from http://snippets.dzone.com/posts/show/4831 and extended to support use of JAR files

Parameters:

classLoader - The class loader to load the classes from.

packageName - The base package or class name

Returns:

A collection of Class objects

getResources

public static Collection<URL> getResources(ClassLoader classLoader,
                                           String packageName,
                                           ClassPathFilter filter)

Find all classes accessible from the class loader which belong to the given package and sub packages. Adapted from http://snippets.dzone.com/posts/show/4831 and extended to support use of JAR files

Parameters:

classLoader - The class loader to load the classes from.

packageName - The package name to locate the classes in.

filter - The filter for the classes.

Returns:

A collection of URL objects