BshClassManager

java.lang.Object
- bsh.BshClassManager

Direct Known Subclasses:

ClassManagerImpl
```
public class BshClassManager
extends java.lang.Object
```
BshClassManager manages all classloading in BeanShell. It also supports a dynamically loaded extension (bsh.classpath package) which allows classpath extension and class file reloading. Currently the extension relies on 1.2 for BshClassLoader and weak references. See http://www.beanshell.org/manual/classloading.html for details on the bsh classloader architecture.
Bsh has a multi-tiered class loading architecture. No class loader is used unless/until the classpath is modified or a class is reloaded.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BshClassManager.Listener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BshClassManager.Listener`

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.Class<?>>`	`absoluteClassCache` Global cache for things we know are classes.
`protected java.util.Set<java.lang.String>`	`absoluteNonClasses` Global cache for things we know are not classes.
`protected java.util.Map<java.lang.String,java.lang.Class<?>>`	`associatedClasses`
`protected java.lang.ClassLoader`	`externalClassLoader` An external classloader supplied by the setClassLoader() command.

Constructor Summary

Constructors
Constructor and Description

BshClassManager()

Constructors
Constructor and Description
`BshClassManager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClassPath(java.net.URL path)`
`void`	`addListener(BshClassManager.Listener l)`
`void`	`associateClass(java.lang.Class<?> clas)` Associate a persistent generated class implementation with this interpreter.
`void`	`cacheClassInfo(java.lang.String name, java.lang.Class<?> value)` Cache info about whether name is a class or not.
`boolean`	`classExists(java.lang.String name)`
`java.lang.Class<?>`	`classForName(java.lang.String name)` Load the specified class by name, taking into account added classpath and reloaded classes, etc.
`protected void`	`classLoaderChanged()`
`protected void`	`clearCaches()` Clear the caches in BshClassManager
`protected static UtilEvalError`	`cmUnavailable()`
`static BshClassManager`	`createClassManager(Interpreter interpreter)` Create a new instance of the class manager.
`java.lang.Class<?>`	`defineClass(java.lang.String name, byte[] code)`
`protected void`	`doSuperImport()` Support for "import *;" Hide details in here as opposed to NameSpace.
`void`	`dump(java.io.PrintWriter pw)`
`java.lang.Class<?>`	`getAssociatedClass(java.lang.String name)`
`protected java.lang.String`	`getClassNameByUnqName(java.lang.String name)` Return the name or null if none is found, Throw an ClassPathException containing detail if name is ambigous.
`java.net.URL`	`getResource(java.lang.String path)` Get a resource URL using the BeanShell classpath
`java.io.InputStream`	`getResourceAsStream(java.lang.String path)` Get a resource stream using the BeanShell classpath
`boolean`	`getStrictJava()`
`protected boolean`	`hasSuperImport()` A "super import" ("import *") operation has been performed.
`protected java.lang.Class<?>`	`loadSourceClass(java.lang.String name)`
`java.lang.Class<?>`	`plainClassForName(java.lang.String name)` Perform a plain Class.forName() or call the externally provided classloader.
`void`	`reloadAllClasses()` Overlay the entire path with a new class loader.
`void`	`reloadClasses(java.lang.String[] classNames)` Reloading classes means creating a new classloader and using it whenever we are asked for classes in the appropriate space.
`void`	`reloadPackage(java.lang.String pack)` Reload all classes in the specified package: e.g.
`void`	`removeListener(BshClassManager.Listener l)`
`void`	`reset()` Clear all loaders and start over.
`void`	`setClassLoader(java.lang.ClassLoader externalCL)` Set an external class loader.
`void`	`setClassPath(java.net.URL[] cp)` Set a new base classpath and create a new base classloader.

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

- Field Detail
  - externalClassLoader
```
protected java.lang.ClassLoader externalClassLoader
```
    An external classloader supplied by the setClassLoader() command.
  - absoluteClassCache
```
protected final transient java.util.Map<java.lang.String,java.lang.Class<?>> absoluteClassCache
```
    Global cache for things we know are classes. Note: these should probably be re-implemented with Soft references. (as opposed to strong or Weak)
  - absoluteNonClasses
```
protected final transient java.util.Set<java.lang.String> absoluteNonClasses
```
    Global cache for things we know are *not* classes. Note: these should probably be re-implemented with Soft references. (as opposed to strong or Weak)
  - associatedClasses
```
protected final transient java.util.Map<java.lang.String,java.lang.Class<?>> associatedClasses
```
    See Also:
    
    associateClass( Class )
- Constructor Detail
  - BshClassManager
```
public BshClassManager()
```
- Method Detail
  - getStrictJava
```
public boolean getStrictJava()
```
  - createClassManager
```
public static BshClassManager createClassManager(Interpreter interpreter)
```
    Create a new instance of the class manager. Class manager instnaces are now associated with the interpreter.
    
    See Also:
    
    bsh.Interpreter.getClassManager(), bsh.Interpreter.setClassLoader( ClassLoader )
  - classExists
```
public boolean classExists(java.lang.String name)
```
  - classForName
```
public java.lang.Class<?> classForName(java.lang.String name)
```
    Load the specified class by name, taking into account added classpath and reloaded classes, etc. Note: Again, this is just a trivial implementation. See bsh.classpath.ClassManagerImpl for the fully functional class management package.
    
    Returns:
    
    the class or null
  - loadSourceClass
```
protected java.lang.Class<?> loadSourceClass(java.lang.String name)
```
  - plainClassForName
```
public java.lang.Class<?> plainClassForName(java.lang.String name)
                                     throws java.lang.ClassNotFoundException
```
    Perform a plain Class.forName() or call the externally provided classloader. If a BshClassManager implementation is loaded the call will be delegated to it, to allow for additional hooks.
    This simply wraps that bottom level class lookup call and provides a central point for monitoring and handling certain Java version dependent bugs, etc.
    
    Returns:
    
    the class
    
    Throws:
    
    java.lang.ClassNotFoundException
    
    See Also:
    
    classForName( String )
  - getResource
```
public java.net.URL getResource(java.lang.String path)
```
    Get a resource URL using the BeanShell classpath
    
    Parameters:
    
    path - should be an absolute path
  - getResourceAsStream
```
public java.io.InputStream getResourceAsStream(java.lang.String path)
```
    Get a resource stream using the BeanShell classpath
    
    Parameters:
    
    path - should be an absolute path
  - cacheClassInfo
```
public void cacheClassInfo(java.lang.String name,
                           java.lang.Class<?> value)
```
    Cache info about whether name is a class or not.
    
    Parameters:
    
    value - if value is non-null, cache the class if value is null, set the flag that it is *not* a class to speed later resolution
  - associateClass
```
public void associateClass(java.lang.Class<?> clas)
```
    Associate a persistent generated class implementation with this interpreter. An associated class will be used in lieu of generating bytecode when a scripted class of the same name is encountered. When such a class is defined in the script it will cause the associated existing class implementation to be initialized (with the static initializer field). This is utilized by the persistent class generator to allow a generated class to bootstrap an interpreter and rendesvous with its implementation script. Class associations currently last for the life of the class manager.
  - getAssociatedClass
```
public java.lang.Class<?> getAssociatedClass(java.lang.String name)
```
  - clearCaches
```
protected void clearCaches()
```
    Clear the caches in BshClassManager
    
    See Also:
    
    void #reset() for external usage
  - setClassLoader
```
public void setClassLoader(java.lang.ClassLoader externalCL)
```
    Set an external class loader. BeanShell will use this at the same point it would otherwise use the plain Class.forName(). i.e. if no explicit classpath management is done from the script (addClassPath(), setClassPath(), reloadClasses()) then BeanShell will only use the supplied classloader. If additional classpath management is done then BeanShell will perform that in addition to the supplied external classloader. However BeanShell is not currently able to reload classes supplied through the external classloader.
  - addClassPath
```
public void addClassPath(java.net.URL path)
                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
```
    Clear all loaders and start over. No class loading.
  - setClassPath
```
public void setClassPath(java.net.URL[] cp)
                  throws UtilEvalError
```
    Set a new base classpath and create a new base classloader. This means all types change.
    
    Throws:
    
    UtilEvalError
  - reloadAllClasses
```
public void reloadAllClasses()
                      throws UtilEvalError
```
    Overlay the entire path with a new class loader. Set the base path to the user path + base path. No point in including the boot class path (can't reload thos).
    
    Throws:
    
    UtilEvalError
  - reloadClasses
```
public void reloadClasses(java.lang.String[] classNames)
                   throws UtilEvalError
```
    Reloading classes means creating a new classloader and using it whenever we are asked for classes in the appropriate space. For this we use a DiscreteFilesClassLoader
    
    Throws:
    
    UtilEvalError
  - reloadPackage
```
public void reloadPackage(java.lang.String pack)
                   throws UtilEvalError
```
    Reload all classes in the specified package: e.g. "com.sun.tools" The special package name "" can be used to refer to unpackaged classes.
    
    Throws:
    
    UtilEvalError
  - doSuperImport
```
protected void doSuperImport()
                      throws UtilEvalError
```
    Support for "import *;" Hide details in here as opposed to NameSpace.
    
    Throws:
    
    UtilEvalError
  - hasSuperImport
```
protected boolean hasSuperImport()
```
    A "super import" ("import *") operation has been performed.
  - getClassNameByUnqName
```
protected java.lang.String getClassNameByUnqName(java.lang.String name)
                                          throws UtilEvalError
```
    Return the name or null if none is found, Throw an ClassPathException containing detail if name is ambigous.
    
    Throws:
    
    UtilEvalError
  - addListener
```
public void addListener(BshClassManager.Listener l)
```
  - removeListener
```
public void removeListener(BshClassManager.Listener l)
```
  - dump
```
public void dump(java.io.PrintWriter pw)
```
  - defineClass
```
public java.lang.Class<?> defineClass(java.lang.String name,
                                      byte[] code)
```
  - classLoaderChanged
```
protected void classLoaderChanged()
```
  - cmUnavailable
```
protected static UtilEvalError cmUnavailable()
```

Class BshClassManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

externalClassLoader

absoluteClassCache

absoluteNonClasses

associatedClasses

Constructor Detail

BshClassManager

Method Detail

getStrictJava

createClassManager

classExists

classForName

loadSourceClass

plainClassForName

getResource

getResourceAsStream

cacheClassInfo

associateClass

getAssociatedClass

clearCaches

setClassLoader

addClassPath

reset

setClassPath

reloadAllClasses

reloadClasses

reloadPackage

doSuperImport

hasSuperImport

getClassNameByUnqName

addListener

removeListener

dump

defineClass

classLoaderChanged

cmUnavailable