maspack.util

Class ClassFinder

java.lang.Object

maspack.util.ClassFinder

public class ClassFinder
extends java.lang.Object

Searches the classpath for classes that match supplied criteria

Author:

Antonio

Constructor Summary

Constructors

Constructor and Description
ClassFinder()

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<java.lang.Class<?>>	findClass(java.lang.String pkg, java.lang.String className) Searches recursively for any class with the name "className" in pkg
static java.util.ArrayList<java.lang.Class<?>>	findClasses(java.io.File dir, java.lang.String pkg, java.util.regex.Pattern regex, java.lang.Class<?> T, boolean recursive) Searches the directory 'dir', gathering classes of type T that match regex.
static java.util.ArrayList<java.lang.Class<?>>	findClasses(java.io.File dir, java.lang.String pkg, java.lang.String regex, java.lang.Class<?> T)
static java.util.ArrayList<java.lang.Class<?>>	findClasses(java.lang.Package pkg, java.lang.Class<?> T)
static java.util.ArrayList<java.lang.Class<?>>	findClasses(java.lang.String pkg, java.lang.Class<?> T)
static java.util.ArrayList<java.lang.Class<?>>	findClasses(java.lang.String pkg, java.lang.String regex, java.lang.Class<?> T, boolean recursive) Scans for all classes accessible from the current one within the supplied package that are a child of the supplied Class T
static java.util.ArrayList<java.lang.Class<?>>	findClasses(java.net.URL url, java.lang.String pkg, java.util.regex.Pattern regex, java.lang.Class<?> T) Searches through all "subdirectories" of a URL, gathering classes of type T that match regex
static java.util.ArrayList<java.lang.String>	findClassNames(java.lang.String pkg, java.lang.Class<?> base)
static java.util.ArrayList<java.lang.String>	findClassNames(java.lang.String pkg, java.lang.Class<?> base, boolean recursive)
static java.util.ArrayList<java.lang.String>	findClassNames(java.lang.String pkg, java.lang.String regex, java.lang.Class<?> base, boolean recursive)
static java.io.File	findPackageDirectory(java.lang.String pkgname) Find the class directory for a particular package, if it exists, This will only be true if the package exists and is loaded from a file system directory instead of a JAR file.
static java.lang.Class<?>	forName(java.lang.String name) Invokes Class.forName(name,true,loader) using the context class loader.
static java.lang.Class<?>	forName(java.lang.String name, boolean initialize) Invokes Class.forName(name,initialize,loader) using the context class loader.
static java.lang.ClassLoader	getContextClassLoader() Returns the class loader to be used by this class.
static java.lang.Class<?>	loadClass(java.lang.String name) Class loadClass(name) for the context class loader.
static void	main(java.lang.String[] args)
static boolean	packageExists(java.lang.String pkgname) Queries whether a package exists, as indicating by the class loader being able to find resources for it.
static void	setClassLoader(java.lang.ClassLoader loader) Explicitly sets the class loader to be used by this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFinder

public ClassFinder()

Method Detail

setClassLoader

public static void setClassLoader(java.lang.ClassLoader loader)

Explicitly sets the class loader to be used by this class. If set to null, the current thread's context class loader will be used instead.

Parameters:

loader - new class loader

getContextClassLoader

public static java.lang.ClassLoader getContextClassLoader()

Returns the class loader to be used by this class. This is either an explicit value set by setClassLoader(java.lang.ClassLoader), or the context class loader of the current thread.

forName

public static java.lang.Class<?> forName(java.lang.String name,
                                         boolean initialize)
                                  throws java.lang.ClassNotFoundException

Invokes Class.forName(name,initialize,loader) using the context class loader.

Throws:

java.lang.ClassNotFoundException

forName

public static java.lang.Class<?> forName(java.lang.String name)
                                  throws java.lang.ClassNotFoundException

Invokes Class.forName(name,true,loader) using the context class loader.

Throws:

java.lang.ClassNotFoundException

loadClass

public static java.lang.Class<?> loadClass(java.lang.String name)
                                    throws java.lang.ClassNotFoundException

Class loadClass(name) for the context class loader.

Throws:

java.lang.ClassNotFoundException

findClassNames

public static java.util.ArrayList<java.lang.String> findClassNames(java.lang.String pkg,
                                                                   java.lang.Class<?> base)

findClassNames

public static java.util.ArrayList<java.lang.String> findClassNames(java.lang.String pkg,
                                                                   java.lang.Class<?> base,
                                                                   boolean recursive)

findClassNames

public static java.util.ArrayList<java.lang.String> findClassNames(java.lang.String pkg,
                                                                   java.lang.String regex,
                                                                   java.lang.Class<?> base,
                                                                   boolean recursive)

findClass

public static java.util.ArrayList<java.lang.Class<?>> findClass(java.lang.String pkg,
                                                                java.lang.String className)

Searches recursively for any class with the name "className" in pkg

Parameters:

pkg - The package to search

className - The name of the class to find

Returns:

An array of results

findClasses

public static java.util.ArrayList<java.lang.Class<?>> findClasses(java.lang.String pkg,
                                                                  java.lang.String regex,
                                                                  java.lang.Class<?> T,
                                                                  boolean recursive)

Scans for all classes accessible from the current one within the supplied package that are a child of the supplied Class T

Parameters:

pkg - string name of package

regex - only keep files matching the regex statement (i.e. ) i.e. regex =".*Demo$" will keep only files ending with "Demo"

T - root class to search for

recursive - if true, recursively search subpackages (does not yet work for JAR files)

findClasses

public static java.util.ArrayList<java.lang.Class<?>> findClasses(java.lang.Package pkg,
                                                                  java.lang.Class<?> T)

findClasses

public static java.util.ArrayList<java.lang.Class<?>> findClasses(java.lang.String pkg,
                                                                  java.lang.Class<?> T)

findClasses

public static java.util.ArrayList<java.lang.Class<?>> findClasses(java.io.File dir,
                                                                  java.lang.String pkg,
                                                                  java.lang.String regex,
                                                                  java.lang.Class<?> T)

findClasses

public static java.util.ArrayList<java.lang.Class<?>> findClasses(java.io.File dir,
                                                                  java.lang.String pkg,
                                                                  java.util.regex.Pattern regex,
                                                                  java.lang.Class<?> T,
                                                                  boolean recursive)

Searches the directory 'dir', gathering classes of type T that match regex.

Parameters:

dir - directory in which to search

pkg - package name

regex - regular expression used to filter class names

T - base type that the class mush be an instance of

recursive - if true, recursively search subdirectories

findClasses

public static java.util.ArrayList<java.lang.Class<?>> findClasses(java.net.URL url,
                                                                  java.lang.String pkg,
                                                                  java.util.regex.Pattern regex,
                                                                  java.lang.Class<?> T)

Searches through all "subdirectories" of a URL, gathering classes of type T that match regex

packageExists

public static boolean packageExists(java.lang.String pkgname)

Queries whether a package exists, as indicating by the class loader being able to find resources for it.

Returns:

true if the package is known to the class loader

findPackageDirectory

public static java.io.File findPackageDirectory(java.lang.String pkgname)

Find the class directory for a particular package, if it exists, This will only be true if the package exists and is loaded from a file system directory instead of a JAR file.

Returns:

package directory, or null if not found

main

public static void main(java.lang.String[] args)