ClassLister (jclasslocator 0.0.19 API)

java.lang.Object
- nz.ac.waikato.cms.locator.ClassLister

All Implemented Interfaces:

java.io.Serializable
```
public class ClassLister
extends java.lang.Object
implements java.io.Serializable
```
Determines the classnames of superclasses that are to be displayed in a GUI for instance.

IMPORTANT NOTE: Due to reentrant threads, the getSingleton() method is not allowed to be called from static {...} blocks in classes that are managed by the ClassLister class (and therefore the ClassLocator class). Since the ClassLocator class loads classes into the JVM, the static {...} block of these classes gets executed and the ClassLister gets initialized once again. In this case, the previous singleton will most likely get overwritten.

Usage examples:
```
 // initialize the class lister
 Properties pkges = ...;  // class hierarchies
 Properties blacklist = ...;  // any blacklisted classes
 ClassLister lister = ClassLister.getSingleton();
 lister.setPackages(pkges);
 lister.setBlacklist(blacklist);
 lister.initialize();
 // use class lister
 Class[] classes = lister.getClasses("my.SuperClass");
 
```
Use "nz.ac.waikato.cms.locator.ClassLister.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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Properties`	`m_Blacklist` the properties with the blacklisted classes.
`protected java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.Class>>`	`m_CacheClasses` the cache (superclass/classes).
`protected java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>`	`m_CacheNames` the cache (superclass/classnames).
`protected ClassTraversal`	`m_ClassTraversal` the class traversal to use.
`protected java.util.HashMap<java.lang.String,java.util.List<java.lang.Class>>`	`m_ListClasses` the list (superclass/classes).
`protected java.util.HashMap<java.lang.String,java.util.List<java.lang.String>>`	`m_ListNames` the list (superclass/classnames).
`protected java.util.logging.Logger`	`m_Logger` the logger in use.
`protected java.util.Set<java.lang.Class>`	`m_ManagedClasses` cache for all managed classs.
`protected java.util.Set<java.lang.String>`	`m_ManagedClassnames` cache for all managed classnames.
`protected boolean`	`m_OnlyDefaultConstructor` whether to allow only classes with the default constructor.
`protected boolean`	`m_OnlySerializable` whether to allow only serializable classes.
`protected java.util.Properties`	`m_Packages` the properties (superclass/packages).
`protected static java.util.Map<java.lang.Class<? extends ClassTraversal>,ClassLister>`	`m_Singleton` the singleton.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ClassLister()
Initializes the classlister.

protected ClassLister(ClassTraversal traversal)
Initializes the classlister.

Constructors
Modifier	Constructor and Description
`protected`	`ClassLister()` Initializes the classlister.
`protected`	`ClassLister(ClassTraversal traversal)` Initializes the classlister.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHierarchy(java.lang.Class superclass, java.lang.Class[] classes)` Adds/appends a class hierarchy.
`void`	`addHierarchy(java.lang.String superclass, java.lang.String[] packages)` Adds/appends a class hierarchy.
`java.lang.Class[]`	`getClasses(java.lang.Class superclass)` Returns all the classs that were found for this superclass.
`java.lang.Class[]`	`getClasses(java.lang.String superclass)` Returns all the classes that were found for this superclass.
`protected ClassLocator`	`getClassLocator()` Returns the `ClassLocator` instance to use.
`java.lang.String[]`	`getClassnames(java.lang.Class superclass)` Returns all the classnames that were found for this superclass.
`ClassTraversal`	`getClassTraversal()` Returns the underlying class traversal.
`java.util.logging.Logger`	`getLogger()` Returns the logger in use.
`java.util.Set<java.lang.Class>`	`getManagedClasses()` Returns the set of managed classes.
`java.util.Set<java.lang.String>`	`getManagedClassnames()` Returns the set of managed class names.
`java.util.Properties`	`getPackages()` Returns the superclass-packages relation.
`java.lang.String[]`	`getPackages(java.lang.Class superclass)` Returns all the packages that were found for this superclass.
`java.lang.String[]`	`getPackages(java.lang.String superclass)` Returns all the packages that were found for this superclass.
`static ClassLister`	`getSingleton()` Returns the singleton instance of the class lister.
`static ClassLister`	`getSingleton(ClassTraversal traversal)` Returns the singleton instance of the class lister.
`java.lang.String[]`	`getSuperclasses()` Returns the all superclasses that define class hierarchies.
`java.lang.String[]`	`getSuperclasses(java.lang.Class cls)` Returns the superclasses that the specified classes was listed under.
`java.lang.String[]`	`getSuperclasses(java.lang.String cls)` Returns the superclasses that the specified classes was listed under.
`void`	`initialize()` loads the props file and interpretes it.
`boolean`	`isLoggingEnabled()` Returns whether logging is enabled.
`boolean`	`isManaged(java.lang.Class cls)` Checks whether the class is listed in one of the hierarchies.
`boolean`	`isManaged(java.lang.String classname)` Checks whether the classname is listed in one of the hierarchies.
`boolean`	`isOnlyDefaultConstructor()` Returns whether to allow only classes with default constructor.
`boolean`	`isOnlySerializable()` Returns whether to allow only serializable classes.
`static java.util.Properties`	`load(java.lang.String props)` Loads the properties from the classpath.
`static java.util.Properties`	`load(java.lang.String props, java.util.Properties defProps)` Loads the properties from the classpath.
`void`	`setBlacklist(java.util.Properties value)` Sets the properties with the blacklisted classes.
`void`	`setOnlyDefaultConstructor(boolean value)` Sets whether to allow only classes with default constructor.
`void`	`setOnlySerializable(boolean value)` Sets whether to allow only serializable classes.
`void`	`setPackages(java.util.Properties value)` Sets the properties with the superclass/packages relation.
`java.util.Properties`	`toPackages()` Returns the class hierarchies as properties object, with the superclasses as keys and the values representing comma-separated lists of packages.
`java.util.Properties`	`toProperties()` Returns the class hierarchies as properties object, with the superclasses as keys and the values representing comma-separated lists of classnames.
`java.lang.String`	`toString()` Only prints the generated props file with all the classnames, based on the package names for the individual packages.
`protected void`	`updateClasses(java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.Class>> cache, java.lang.String superclass, java.util.HashSet<java.lang.Class> names)` Updates cache for the superclass.
`protected void`	`updateClasses(java.util.HashMap<java.lang.String,java.util.List<java.lang.Class>> list, java.lang.String superclass, java.util.List<java.lang.Class> classes)` Updates list for the superclass.
`protected void`	`updateClassnames(java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> cache, java.lang.String superclass, java.util.HashSet<java.lang.String> names)` Updates cache for the superclass.
`protected void`	`updateClassnames(java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> list, java.lang.String superclass, java.util.List<java.lang.String> names)` Updates list for the superclass.

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

- Field Detail
  - m_Logger
```
protected transient java.util.logging.Logger m_Logger
```
    the logger in use.
  - m_Packages
```
protected java.util.Properties m_Packages
```
    the properties (superclass/packages).
  - m_CacheNames
```
protected java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> m_CacheNames
```
    the cache (superclass/classnames).
  - m_ListNames
```
protected java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> m_ListNames
```
    the list (superclass/classnames).
  - m_CacheClasses
```
protected java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.Class>> m_CacheClasses
```
    the cache (superclass/classes).
  - m_ListClasses
```
protected java.util.HashMap<java.lang.String,java.util.List<java.lang.Class>> m_ListClasses
```
    the list (superclass/classes).
  - m_ManagedClassnames
```
protected java.util.Set<java.lang.String> m_ManagedClassnames
```
    cache for all managed classnames.
  - m_ManagedClasses
```
protected java.util.Set<java.lang.Class> m_ManagedClasses
```
    cache for all managed classs.
  - m_Blacklist
```
protected java.util.Properties m_Blacklist
```
    the properties with the blacklisted classes.
  - m_OnlyDefaultConstructor
```
protected boolean m_OnlyDefaultConstructor
```
    whether to allow only classes with the default constructor.
  - m_OnlySerializable
```
protected boolean m_OnlySerializable
```
    whether to allow only serializable classes.
  - m_ClassTraversal
```
protected ClassTraversal m_ClassTraversal
```
    the class traversal to use.
  - m_Singleton
```
protected static java.util.Map<java.lang.Class<? extends ClassTraversal>,ClassLister> m_Singleton
```
    the singleton.
- Constructor Detail
  - ClassLister
```
protected ClassLister()
```
    Initializes the classlister.
  - ClassLister
```
protected ClassLister(ClassTraversal traversal)
```
    Initializes the classlister.
- 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
  - getClassTraversal
```
public ClassTraversal getClassTraversal()
```
    Returns the underlying class traversal.
    
    Returns:
    
    the traversal scheme
  - setOnlyDefaultConstructor
```
public void setOnlyDefaultConstructor(boolean value)
```
    Sets whether to allow only classes with default constructor.
    
    Parameters:
    
    value - true if only default allowed
  - isOnlyDefaultConstructor
```
public boolean isOnlyDefaultConstructor()
```
    Returns whether to allow only classes with default constructor.
    
    Returns:
    
    true if only default allowed
  - setOnlySerializable
```
public void setOnlySerializable(boolean value)
```
    Sets whether to allow only serializable classes.
    
    Parameters:
    
    value - true if only serializable
  - isOnlySerializable
```
public boolean isOnlySerializable()
```
    Returns whether to allow only serializable classes.
    
    Returns:
    
    true if only serializable
  - setPackages
```
public void setPackages(java.util.Properties value)
```
    Sets the properties with the superclass/packages relation.
    
    Parameters:
    
    value - the properties
  - setBlacklist
```
public void setBlacklist(java.util.Properties value)
```
    Sets the properties with the blacklisted classes.
    
    Parameters:
    
    value - the properties
  - updateClassnames
```
protected void updateClassnames(java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> cache,
                                java.lang.String superclass,
                                java.util.HashSet<java.lang.String> names)
```
    Updates cache for the superclass.
    
    Parameters:
    
    cache - the cache to update
    
    superclass - the superclass
    
    names - the names to add
  - updateClassnames
```
protected void updateClassnames(java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> list,
                                java.lang.String superclass,
                                java.util.List<java.lang.String> names)
```
    Updates list for the superclass.
    
    Parameters:
    
    list - the list to update
    
    superclass - the superclass
    
    names - the names to add
  - updateClasses
```
protected void updateClasses(java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.Class>> cache,
                             java.lang.String superclass,
                             java.util.HashSet<java.lang.Class> names)
```
    Updates cache for the superclass.
    
    Parameters:
    
    cache - the cache to update
    
    superclass - the superclass
    
    names - the names to add
  - updateClasses
```
protected void updateClasses(java.util.HashMap<java.lang.String,java.util.List<java.lang.Class>> list,
                             java.lang.String superclass,
                             java.util.List<java.lang.Class> classes)
```
    Updates list for the superclass.
    
    Parameters:
    
    list - the list to update
    
    superclass - the superclass
    
    classes - the names to add
  - getClassLocator
```
protected ClassLocator getClassLocator()
```
    Returns the ClassLocator instance to use.
    
    Returns:
    
    the instance
  - addHierarchy
```
public void addHierarchy(java.lang.String superclass,
                         java.lang.String[] packages)
```
    Adds/appends a class hierarchy.
    
    Parameters:
    
    superclass - the superclass
    
    packages - the packages
  - addHierarchy
```
public void addHierarchy(java.lang.Class superclass,
                         java.lang.Class[] classes)
```
    Adds/appends a class hierarchy.
    
    Parameters:
    
    superclass - the superclass
    
    classes - the classes
  - initialize
```
public void initialize()
```
    loads the props file and interpretes it.
  - getClassnames
```
public java.lang.String[] getClassnames(java.lang.Class superclass)
```
    Returns all the classnames that were found for this superclass.
    
    Parameters:
    
    superclass - the superclass to return the derived classes for
    
    Returns:
    
    the classnames of the derived classes
  - getClasses
```
public java.lang.Class[] getClasses(java.lang.Class superclass)
```
    Returns all the classs that were found for this superclass.
    
    Parameters:
    
    superclass - the superclass to return the derived classes for
    
    Returns:
    
    the classes of the derived classes
  - getClasses
```
public java.lang.Class[] getClasses(java.lang.String superclass)
```
    Returns all the classes that were found for this superclass.
    
    Parameters:
    
    superclass - the superclass to return the derived classes for
    
    Returns:
    
    the classes of the derived classes
  - getSuperclasses
```
public java.lang.String[] getSuperclasses(java.lang.Class cls)
```
    Returns the superclasses that the specified classes was listed under.
    
    Parameters:
    
    cls - the class to look up its superclasses
    
    Returns:
    
    the superclass(es)
  - getSuperclasses
```
public java.lang.String[] getSuperclasses(java.lang.String cls)
```
    Returns the superclasses that the specified classes was listed under.
    
    Parameters:
    
    cls - the class to look up its superclasses
    
    Returns:
    
    the superclass(es)
  - getSuperclasses
```
public java.lang.String[] getSuperclasses()
```
    Returns the all superclasses that define class hierarchies.
    
    Returns:
    
    the superclasses
  - getPackages
```
public java.lang.String[] getPackages(java.lang.Class superclass)
```
    Returns all the packages that were found for this superclass.
    
    Parameters:
    
    superclass - the superclass to return the packages for
    
    Returns:
    
    the packages
  - getPackages
```
public java.lang.String[] getPackages(java.lang.String superclass)
```
    Returns all the packages that were found for this superclass.
    
    Parameters:
    
    superclass - the superclass to return the packages for
    
    Returns:
    
    the packages
  - getPackages
```
public java.util.Properties getPackages()
```
    Returns the superclass-packages relation.
    
    Returns:
    
    the properties object listing the packages
  - isManaged
```
public boolean isManaged(java.lang.Class cls)
```
    Checks whether the class is listed in one of the hierarchies.
    
    Parameters:
    
    cls - the class to check
    
    Returns:
    
    true if listed
  - getManagedClasses
```
public java.util.Set<java.lang.Class> getManagedClasses()
```
    Returns the set of managed classes.
    
    Returns:
    
    the set
  - isManaged
```
public boolean isManaged(java.lang.String classname)
```
    Checks whether the classname is listed in one of the hierarchies.
    
    Parameters:
    
    classname - the classname to check
    
    Returns:
    
    true if listed
  - getManagedClassnames
```
public java.util.Set<java.lang.String> getManagedClassnames()
```
    Returns the set of managed class names.
    
    Returns:
    
    the set
  - toProperties
```
public java.util.Properties toProperties()
```
    Returns the class hierarchies as properties object, with the superclasses as keys and the values representing comma-separated lists of classnames.
    
    Returns:
    
    the generated properties
  - toPackages
```
public java.util.Properties toPackages()
```
    Returns the class hierarchies as properties object, with the superclasses as keys and the values representing comma-separated lists of packages.
    
    Returns:
    
    the generated properties
  - toString
```
public java.lang.String toString()
```
    Only prints the generated props file with all the classnames, based on the package names for the individual packages.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the props file with the classnames
  - getSingleton
```
public static ClassLister getSingleton()
```
    Returns the singleton instance of the class lister.
    
    Returns:
    
    the singleton
  - getSingleton
```
public static ClassLister getSingleton(ClassTraversal traversal)
```
    Returns the singleton instance of the class lister.
    
    Parameters:
    
    traversal - the class traversal to use, can be null for default one
    
    Returns:
    
    the singleton
  - load
```
public static java.util.Properties load(java.lang.String props)
```
    Loads the properties from the classpath.
    
    Parameters:
    
    props - the path, e.g., "nz/ac/waikato/cms/locator/ClassLister.props"
    
    Returns:
    
    the properties
  - load
```
public static java.util.Properties load(java.lang.String props,
                                        java.util.Properties defProps)
```
    Loads the properties from the classpath.
    
    Parameters:
    
    props - the path, e.g., "nz/ac/waikato/cms/locator/ClassLister.props"
    
    Returns:
    
    the properties, the default ones if failed to load

Class ClassLister

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_Logger

m_Packages

m_CacheNames

m_ListNames

m_CacheClasses

m_ListClasses

m_ManagedClassnames

m_ManagedClasses

m_Blacklist

m_OnlyDefaultConstructor

m_OnlySerializable

m_ClassTraversal

m_Singleton

Constructor Detail

ClassLister

ClassLister

Method Detail

isLoggingEnabled

getLogger

getClassTraversal

setOnlyDefaultConstructor

isOnlyDefaultConstructor

setOnlySerializable

isOnlySerializable

setPackages

setBlacklist

updateClassnames

updateClassnames

updateClasses

updateClasses

getClassLocator

addHierarchy

addHierarchy

initialize

getClassnames

getClasses

getClasses

getSuperclasses

getSuperclasses

getSuperclasses

getPackages

getPackages

getPackages

isManaged

getManagedClasses

isManaged

getManagedClassnames

toProperties

toPackages

toString

getSingleton

getSingleton

load

load