nz.ac.waikato.cms.locator

Class ClassPathTraversal

java.lang.Object

nz.ac.waikato.cms.locator.AbstractClassTraversal

nz.ac.waikato.cms.locator.ClassPathTraversal

All Implemented Interfaces:

java.io.Serializable, ClassTraversal

public class ClassPathTraversal
extends AbstractClassTraversal

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 and Description
static class	ClassPathTraversal.ClassFileFilter For filtering classes.
static class	ClassPathTraversal.DirectoryFilter For filtering classes.
static class	ClassPathTraversal.TraversalState Container class for maintaining the state while traversing.

Field Summary

Fields inherited from class nz.ac.waikato.cms.locator.AbstractClassTraversal

DEFAULT_PACKAGE, m_Logger

Constructor Summary

Constructors

Constructor and Description
ClassPathTraversal()

Method Summary

Modifier and Type	Method and Description
void	traverse(java.lang.String classname, ClassPathTraversal.TraversalState state) Traverses the class, calls the listener available through the state.
void	traverse(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 nz.ac.waikato.cms.locator.AbstractClassTraversal

cleanUp, extractPackage, getLogger, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathTraversal

public ClassPathTraversal()

Method Detail

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

Traverses the classpath.

Specified by:

traverse in interface ClassTraversal

Specified by:

traverse in class AbstractClassTraversal

Parameters:

listener - the listener to use