Package nz.ac.waikato.cms.locator

Class ClassCache

java.lang.Object

nz.ac.waikato.cms.locator.ClassCache

All Implemented Interfaces:

java.io.Serializable

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

A class that stores all classes on the classpath.
Use "nz.ac.waikato.cms.locator.ClassCache.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	ClassCache.Listener	For listening to the class traversal and populating the caches.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.logging.Logger	m_Logger	the logger in use.
protected java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>	m_NameCache	for caching all classes on the class path (package-name <-> HashSet with classnames).

Constructor Summary

Constructors

Constructor	Description
ClassCache()	Initializes the cache.

Method Summary

Modifier and Type	Method	Description
java.util.HashSet<java.lang.String>	getClassnames(java.lang.String pkgname)	Returns all the classes for the given package.
java.util.logging.Logger	getLogger()	Returns the logger in use.
protected void	initialize()	Initializes the cache.
boolean	isLoggingEnabled()	Returns whether logging is enabled.
static void	main(java.lang.String[] args)	For testing only.
java.util.Iterator<java.lang.String>	packages()	Returns all the stored packages.
boolean	remove(java.lang.String classname)	Removes the classname from the cache.

Methods inherited from class java.lang.Object

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

Field Detail

m_Logger

protected transient java.util.logging.Logger m_Logger

the logger in use.

m_NameCache

protected java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> m_NameCache

for caching all classes on the class path (package-name <-> HashSet with classnames).

Constructor Detail

ClassCache

public ClassCache()

Initializes the cache.

Method Detail

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

remove

public boolean remove(java.lang.String classname)

Removes the classname from the cache.

Parameters:

classname - the classname to remove

Returns:

true if the removal changed the cache

packages

public java.util.Iterator<java.lang.String> packages()

Returns all the stored packages.

Returns:

the package names

getClassnames

public java.util.HashSet<java.lang.String> getClassnames(java.lang.String pkgname)

Returns all the classes for the given package.

Parameters:

pkgname - the package to get the classes for

Returns:

the classes (sorted by name)

initialize

protected void initialize()

Initializes the cache.

main

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

For testing only.

Parameters:

args - ignored