Package nz.ac.waikato.cms.locator

Class ClassPathTraversal

java.lang.Object

nz.ac.waikato.cms.locator.ClassPathTraversal

All Implemented Interfaces:

java.io.Serializable

public class ClassPathTraversal
extends java.lang.Object
implements java.io.Serializable

For traversing the classpath.
Use "nz.ac.waikato.cms.locator.ClassPathTraversal.LOGLEVEL" with a value of "{OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST}" to set custom logging level.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassPathTraversal.ClassFileFilter	For filtering classes.
static class	ClassPathTraversal.DirectoryFilter	For filtering classes.
static interface	ClassPathTraversal.TraversalListener	Interface for classes that listen to the traversal of the classpath.
static class	ClassPathTraversal.TraversalState	Container class for maintaining the state while traversing.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_PACKAGE	the key for the default package.
protected java.util.logging.Logger	m_Logger	the logger in use.

Constructor Summary

Constructors

Constructor	Description
ClassPathTraversal()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	cleanUp(java.lang.String classname)	Fixes the classname, turns "/" and "\" into "." and removes ".class".
static java.lang.String	extractPackage(java.lang.String classname)	Extracts the package name from the (clean) classname.
java.util.logging.Logger	getLogger()	Returns the logger in use.
boolean	isLoggingEnabled()	Returns whether logging is enabled.
void	traverse(java.lang.String classname, ClassPathTraversal.TraversalState state)	Traverses the class, calls the listener available through the state.
void	traverse(ClassPathTraversal.TraversalListener listener)	Traverses the classpath.
protected void	traverseClasspathPart(java.lang.String part, ClassPathTraversal.TraversalState state)	Analyzes a part of the classpath.
protected void	traverseDir(java.io.File dir, ClassPathTraversal.TraversalState state)	Fills the class cache with classes in the specified directory.
protected void	traverseDir(java.lang.String prefix, java.io.File dir, ClassPathTraversal.TraversalState state)	Fills the class cache with classes in the specified directory.
protected void	traverseJar(java.io.File file, ClassPathTraversal.TraversalState state)	Fills the class cache with classes from the specified jar.
protected void	traverseManifest(java.util.jar.Manifest manifest, ClassPathTraversal.TraversalState state)	Analyzes the MANIFEST.MF file of a jar whether additional jars are listed in the "Class-Path" key.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PACKAGE

public static final java.lang.String DEFAULT_PACKAGE

the key for the default package.

See Also:

Constant Field Values

m_Logger

protected transient java.util.logging.Logger m_Logger

the logger in use.

Constructor Detail

ClassPathTraversal

public ClassPathTraversal()

Method Detail

extractPackage

public static java.lang.String extractPackage(java.lang.String classname)

Extracts the package name from the (clean) classname.

Parameters:

classname - the classname to extract the package from

Returns:

the package name

cleanUp

public static java.lang.String cleanUp(java.lang.String classname)

Fixes the classname, turns "/" and "\" into "." and removes ".class".

Parameters:

classname - the classname to process

Returns:

the processed classname

isLoggingEnabled

public boolean isLoggingEnabled()

Returns whether logging is enabled.

Returns:

true if enabled

getLogger

public java.util.logging.Logger getLogger()

Returns the logger in use.

Returns:

the logger

traverse

public void traverse(java.lang.String classname,
                     ClassPathTraversal.TraversalState state)

Traverses the class, calls the listener available through the state.

Parameters:

classname - the classname, automatically removes ".class" and turns "/" or "\" into "."

state - the traversal state

traverseDir

protected void traverseDir(java.lang.String prefix,
                           java.io.File dir,
                           ClassPathTraversal.TraversalState state)

Fills the class cache with classes in the specified directory.

Parameters:

prefix - the package prefix so far, null for default package

dir - the directory to search

state - the traversal state

traverseDir

protected void traverseDir(java.io.File dir,
                           ClassPathTraversal.TraversalState state)

Fills the class cache with classes in the specified directory.

Parameters:

dir - the directory to search

state - the traversal state

traverseManifest

protected void traverseManifest(java.util.jar.Manifest manifest,
                                ClassPathTraversal.TraversalState state)

Analyzes the MANIFEST.MF file of a jar whether additional jars are listed in the "Class-Path" key.

Parameters:

manifest - the manifest to analyze

state - the traversal state

traverseJar

protected void traverseJar(java.io.File file,
                           ClassPathTraversal.TraversalState state)

Fills the class cache with classes from the specified jar.

Parameters:

file - the jar to inspect

state - the traversal state

traverseClasspathPart

protected void traverseClasspathPart(java.lang.String part,
                                     ClassPathTraversal.TraversalState state)

Analyzes a part of the classpath.

Parameters:

part - the part to analyze

state - the traversal state

traverse

public void traverse(ClassPathTraversal.TraversalListener listener)

Traverses the classpath.

Parameters:

listener - the listener to use