ClassCache (jclasslocator 0.0.19 API)

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 and Description

static class ClassCache.Listener
For listening to the class traversal and populating the caches.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClassCache.Listener` For listening to the class traversal and populating the caches.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<java.lang.String>`	`m_AbstractClasses` cache for abstract classes.
`protected java.util.regex.Pattern`	`m_AnonymousCheck` for checking whether an anonymous class.
`protected java.util.Map<java.net.URL,java.util.Set<java.lang.String>>`	`m_ClasspathPartCache` the classpath path part cache (classpath part <-> set with classnames).
`protected java.util.logging.Logger`	`m_Logger` the logger in use.
`protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>`	`m_NameCache` for caching all classes on the class path (package-name <-> Set with classnames).
`static java.lang.String`	`PATTERN_ANONYMOUS` the regexp pattern for identifying anonymous classes.

Constructor Summary

Constructors
Constructor and Description

ClassCache()
Initializes the cache.

ClassCache(ClassTraversal traversal)
Initializes the cache.

Constructors
Constructor and Description
`ClassCache()` Initializes the cache.
`ClassCache(ClassTraversal traversal)` Initializes the cache.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Iterator<java.net.URL>`	`classpathParts()` Returns all the stored classpath parts.
`java.util.Iterator<java.net.URL>`	`classpathParts(java.lang.String regexp)` Returns all the stored classpath parts that match the provided regular expression.
`java.util.List<java.net.URL>`	`classpathPartsForClass(java.lang.Class cls)` Returns the classpath parts that contain the specified class (eg to find duplicates).
`java.util.List<java.net.URL>`	`classpathPartsForClass(java.lang.String classname)` Returns the classpath parts that contain the specified class (eg to find duplicates).
`java.util.Set<java.lang.String>`	`getClassnames(java.lang.String pkgname)` Returns all the classes for the given package.
`java.util.Set<java.lang.String>`	`getClassnames(java.lang.String pkgname, boolean excludeAbstract)` Returns all the classes for the given package.
`java.util.Set<java.lang.String>`	`getClassnames(java.net.URL part)` Returns all the classes for the given classpath part.
`java.util.Set<java.lang.String>`	`getClassnames(java.net.URL part, boolean excludeAbstract)` Returns all the classes for the given classpath part.
`java.util.logging.Logger`	`getLogger()` Returns the logger in use.
`protected void`	`initialize(ClassTraversal traversal)` Initializes the cache.
`boolean`	`isAbstract(java.lang.String classname)` Returns whether the class has been flagged as abstract.
`boolean`	`isAnonymous(java.lang.String classname)` Returns whether the class is an anonymous one ("...$X" with X being a number).
`boolean`	`isEmpty()` Returns whether the cache is empty.
`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.
`java.util.Iterator<java.lang.String>`	`packages(java.lang.String regexp)` Returns all the stored packages that match the provided regular expression.
`boolean`	`remove(java.lang.String classname)` Removes the classname from the cache.
`void`	`setAbstract(java.lang.String classname, boolean value)` Flags or clears a class as being abstract.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PATTERN_ANONYMOUS
```
public static final java.lang.String PATTERN_ANONYMOUS
```
    the regexp pattern for identifying anonymous classes.
    
    See Also:
    
    Constant Field Values
  - m_Logger
```
protected transient java.util.logging.Logger m_Logger
```
    the logger in use.
  - m_NameCache
```
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> m_NameCache
```
    for caching all classes on the class path (package-name <-> Set with classnames).
  - m_ClasspathPartCache
```
protected java.util.Map<java.net.URL,java.util.Set<java.lang.String>> m_ClasspathPartCache
```
    the classpath path part cache (classpath part <-> set with classnames).
  - m_AbstractClasses
```
protected java.util.Set<java.lang.String> m_AbstractClasses
```
    cache for abstract classes.
  - m_AnonymousCheck
```
protected java.util.regex.Pattern m_AnonymousCheck
```
    for checking whether an anonymous class.
- Constructor Detail
  - ClassCache
```
public ClassCache()
```
    Initializes the cache. Uses the ClassPathTraversal class.
  - ClassCache
```
public ClassCache(ClassTraversal traversal)
```
    Initializes the cache.
    
    Parameters:
    
    traversal - the traversal instance to use, can be null
- Method Detail
  - initialize
```
protected void initialize(ClassTraversal traversal)
```
    Initializes the cache.
  - 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
  - setAbstract
```
public void setAbstract(java.lang.String classname,
                        boolean value)
```
    Flags or clears a class as being abstract.
    
    Parameters:
    
    classname - the class
    
    value - whether to flag as abstract or clear
  - isAbstract
```
public boolean isAbstract(java.lang.String classname)
```
    Returns whether the class has been flagged as abstract.
    
    Parameters:
    
    classname - the class
    
    Returns:
    
    true if flagged as abstract
  - isAnonymous
```
public boolean isAnonymous(java.lang.String classname)
```
    Returns whether the class is an anonymous one ("...$X" with X being a number).
    
    Parameters:
    
    classname -
    
    Returns:
  - packages
```
public java.util.Iterator<java.lang.String> packages()
```
    Returns all the stored packages.
    
    Returns:
    
    the package names
  - packages
```
public java.util.Iterator<java.lang.String> packages(java.lang.String regexp)
```
    Returns all the stored packages that match the provided regular expression.
    
    Parameters:
    
    regexp - the regular expression that the package names must match
    
    Returns:
    
    the package names
  - getClassnames
```
public java.util.Set<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
  - getClassnames
```
public java.util.Set<java.lang.String> getClassnames(java.lang.String pkgname,
                                                     boolean excludeAbstract)
```
    Returns all the classes for the given package.
    
    Parameters:
    
    pkgname - the package to get the classes for
    
    excludeAbstract - whether to exclude abstract classes
    
    Returns:
    
    the classes
  - classpathParts
```
public java.util.Iterator<java.net.URL> classpathParts()
```
    Returns all the stored classpath parts.
    
    Returns:
    
    the classpath parts
  - classpathParts
```
public java.util.Iterator<java.net.URL> classpathParts(java.lang.String regexp)
```
    Returns all the stored classpath parts that match the provided regular expression.
    
    Parameters:
    
    regexp - the regular expression that the URLs must match
    
    Returns:
    
    the classpath parts
  - classpathPartsForClass
```
public java.util.List<java.net.URL> classpathPartsForClass(java.lang.Class cls)
```
    Returns the classpath parts that contain the specified class (eg to find duplicates).
    
    Parameters:
    
    cls - the class to look for
    
    Returns:
    
    the parts of the classpath the class was located in
  - classpathPartsForClass
```
public java.util.List<java.net.URL> classpathPartsForClass(java.lang.String classname)
```
    Returns the classpath parts that contain the specified class (eg to find duplicates).
    
    Parameters:
    
    classname - the class to look for
    
    Returns:
    
    the parts of the classpath the class was located in
  - getClassnames
```
public java.util.Set<java.lang.String> getClassnames(java.net.URL part)
```
    Returns all the classes for the given classpath part.
    
    Parameters:
    
    part - the classpath part to get the classes for
    
    Returns:
    
    the classes
  - getClassnames
```
public java.util.Set<java.lang.String> getClassnames(java.net.URL part,
                                                     boolean excludeAbstract)
```
    Returns all the classes for the given classpath part.
    
    Parameters:
    
    part - the classpath part to get the classes for
    
    excludeAbstract - whether to exclude abstract classes
    
    Returns:
    
    the classes
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether the cache is empty.
    
    Returns:
    
    true if empty
  - main
```
public static void main(java.lang.String[] args)
```
    For testing only.
    
    Parameters:
    
    args - ignored

Class ClassCache

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATTERN_ANONYMOUS

m_Logger

m_NameCache

m_ClasspathPartCache

m_AbstractClasses

m_AnonymousCheck

Constructor Detail

ClassCache

ClassCache

Method Detail

initialize

isLoggingEnabled

getLogger

remove

setAbstract

isAbstract

isAnonymous

packages

packages

getClassnames

getClassnames

classpathParts

classpathParts

classpathPartsForClass

classpathPartsForClass

getClassnames

getClassnames

isEmpty

main