Modifier and Type	Class and Description
public static interface	BshClassManager.Listener
pack-priv static class	BshClassManager.SignatureKey SignatureKey serves as a hash of a method signature on a class for fast lookup of overloaded and general resolved Java methods.

Modifier and Type	Field and Description
protected transient Hashtable<K, V>	absoluteClassCache Global cache for things we know are classes.
protected transient Hashtable<K, V>	absoluteNonClasses Global cache for things we know are not classes.
private Interpreter	declaringInterpreter The interpreter which created the class manager This is used to load scripted classes from source files.
protected transient Hashtable<K, V>	definingClasses
protected transient Hashtable<K, V>	definingClassesBaseNames
protected ClassLoader	externalClassLoader An external classloader supplied by the setClassLoader() command.
private static Object	NOVALUE Identifier for no value item.
protected transient Hashtable<K, V>	resolvedObjectMethods Caches for resolved object and static methods.
protected transient Hashtable<K, V>	resolvedStaticMethods

Access	Constructor and Description
public	BshClassManager()

Method Summary

Modifier and Type	Method and Description
public void	addClassPath(URL path)
public void	addListener(BshClassManager.Listener l)
public void	cacheClassInfo(String name, Class<T> 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 value) Cache info about whether name is a class or not.
public void	cacheResolvedMethod(Class<T> clas, Class<T>[] types, Method method) Cache a resolved (possibly overloaded) method based on the argument types used to invoke it, subject to classloader change.
public boolean	classExists(String name)
public Class<T>	Returns: the class or null classForName(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.
protected void	classLoaderChanged()
protected void	clearCaches() Clear the caches in BshClassManager
protected static UtilEvalError	cmUnavailable()
public static BshClassManager	createClassManager(Interpreter interpreter) Create a new instance of the class manager.
public Class<T>	defineClass(String name, byte[] code)
protected void	definingClass(String className) Flag the class name as being in the process of being defined.
protected void	doneDefiningClass(String className) Indicate that the specified class name has been defined and may be loaded normally.
protected void	doSuperImport() Support for "import *;" Hide details in here as opposed to NameSpace.
public void	dump(PrintWriter pw)
protected String	getClassBeingDefined(String className) This method is a temporary workaround used with definingClass.
protected String	getClassNameByUnqName(String name) Return the name or null if none is found, Throw an ClassPathException containing detail if name is ambigous.
protected Method	Returns: the Method or null getResolvedMethod(Class<T> clas, String methodName, Class<T>[] types, boolean specifies that only a static method may be returned. onlyStatic) Return a previously cached resolved method.
public URL	getResource(String should be an absolute path path) Get a resource URL using the BeanShell classpath
public InputStream	getResourceAsStream(String should be an absolute path path) Get a resource stream using the BeanShell classpath
protected boolean	hasSuperImport() A "super import" ("import *") operation has been performed.
protected boolean	isClassBeingDefined(String className)
protected Class<T>	loadSourceClass(String name)
protected static Error	noClassDefFound(String className, Error e) Annotate the NoClassDefFoundError with some info about the class we were trying to load.
public Class<T>	Returns: the class plainClassForName(String name) Perform a plain Class.forName() or call the externally provided classloader.
public void	reloadAllClasses() Overlay the entire path with a new class loader.
public void	reloadClasses(String[] classNames) Reloading classes means creating a new classloader and using it whenever we are asked for classes in the appropriate space.
public void	reloadPackage(String pack) Reload all classes in the specified package: e.g. "com.sun.tools" The special package name "<unpackaged>" can be used to refer to unpackaged classes.
public void	removeListener(BshClassManager.Listener l)
public void	reset() Clear all loaders and start over.
public void	setClassLoader(ClassLoader externalCL) Set an external class loader.
public void	setClassPath(URL[] cp) Set a new base classpath and create a new base classloader.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

absoluteClassCache	back to summary
protected transient Hashtable<K, V> 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	back to summary
protected transient Hashtable<K, V> 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)

declaringInterpreter	back to summary
private Interpreter declaringInterpreter The interpreter which created the class manager This is used to load scripted classes from source files.

definingClasses	back to summary
protected transient Hashtable<K, V> definingClasses

definingClassesBaseNames	back to summary
protected transient Hashtable<K, V> definingClassesBaseNames

externalClassLoader	back to summary
protected ClassLoader externalClassLoader An external classloader supplied by the setClassLoader() command.

NOVALUE	back to summary
private static Object NOVALUE Identifier for no value item. Use a hashtable as a Set.

resolvedObjectMethods	back to summary
protected transient Hashtable<K, V> resolvedObjectMethods Caches for resolved object and static methods. We keep these maps separate to support fast lookup in the general case where the method may be either.

resolvedStaticMethods	back to summary
protected transient Hashtable<K, V> resolvedStaticMethods

BshClassManager	back to summary
public BshClassManager()

Method Detail

addClassPath	back to summary
public void addClassPath(URL path) throws IOException

addListener	back to summary
public void addListener(BshClassManager.Listener l)

cacheClassInfo	back to summary
public void cacheClassInfo(String name, Class<T> value) Cache info about whether name is a class or not. Parameters value:Class<T> 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

cacheClassInfo

back to summary

public void cacheClassInfo(String name, Class<T> value)

Cache info about whether name is a class or not.

Parameters

value:Class<T>: 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

cacheResolvedMethod	back to summary
public void cacheResolvedMethod(Class<T> clas, Class<T>[] types, Method method) Cache a resolved (possibly overloaded) method based on the argument types used to invoke it, subject to classloader change. Static and Object methods are cached separately to support fast lookup in the general case where either will do.

classExists	back to summary
public boolean classExists(String name)

classForName	back to summary
public Class<T> classForName(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:Class<T> the class or null

classForName

back to summary

public Class<T> classForName(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:Class<T>: the class or null

classLoaderChanged	back to summary
protected void classLoaderChanged()

clearCaches back to summary

clearCaches	back to summary
protected void clearCaches() Clear the caches in BshClassManager See Also `void #reset() for external usage`

protected void clearCaches()

Clear the caches in BshClassManager

See Also: void #reset() for external usage

cmUnavailable	back to summary
protected static UtilEvalError cmUnavailable()

createClassManager back to summary

createClassManager	back to summary
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)`

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)

defineClass	back to summary
public Class<T> defineClass(String name, byte[] code)

definingClass	back to summary
protected void definingClass(String className) Flag the class name as being in the process of being defined. The class manager will not attempt to load it.

doneDefiningClass	back to summary
protected void doneDefiningClass(String className) Indicate that the specified class name has been defined and may be loaded normally.

doSuperImport	back to summary
protected void doSuperImport() throws UtilEvalError Support for "import *;" Hide details in here as opposed to NameSpace.

dump	back to summary
public void dump(PrintWriter pw)

getClassBeingDefined	back to summary
protected String getClassBeingDefined(String className) This method is a temporary workaround used with definingClass. It is to be removed at some point.

getClassNameByUnqName	back to summary
protected String getClassNameByUnqName(String name) throws UtilEvalError Return the name or null if none is found, Throw an ClassPathException containing detail if name is ambigous.

getResolvedMethod	back to summary
protected Method getResolvedMethod(Class<T> clas, String methodName, Class<T>[] types, boolean onlyStatic) Return a previously cached resolved method. Parameters onlyStatic:boolean specifies that only a static method may be returned. Returns:Method the Method or null

getResolvedMethod

back to summary

protected Method getResolvedMethod(Class<T> clas, String methodName, Class<T>[] types, boolean onlyStatic)

Return a previously cached resolved method.

Parameters

onlyStatic:boolean: specifies that only a static method may be returned.

Returns:Method

the Method or null

getResource	back to summary
public URL getResource(String path) Get a resource URL using the BeanShell classpath Parameters path:String should be an absolute path

getResource

back to summary

public URL getResource(String path)

Get a resource URL using the BeanShell classpath

Parameters

path:String: should be an absolute path

getResourceAsStream	back to summary
public InputStream getResourceAsStream(String path) Get a resource stream using the BeanShell classpath Parameters path:String should be an absolute path

getResourceAsStream

back to summary

public InputStream getResourceAsStream(String path)

Get a resource stream using the BeanShell classpath

Parameters

path:String: should be an absolute path

hasSuperImport	back to summary
protected boolean hasSuperImport() A "super import" ("import *") operation has been performed.

isClassBeingDefined	back to summary
protected boolean isClassBeingDefined(String className)

loadSourceClass	back to summary
protected Class<T> loadSourceClass(String name)

noClassDefFound	back to summary
protected static Error noClassDefFound(String className, Error e) Annotate the NoClassDefFoundError with some info about the class we were trying to load.

plainClassForName back to summary

plainClassForName	back to summary
public Class<T> plainClassForName(String name) throws 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:Class<T> the class See Also `classForName(String)`

public Class<T> plainClassForName(String name) throws 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:Class<T>: the class
See Also: classForName(String)

reloadAllClasses	back to summary
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).

reloadClasses	back to summary
public void reloadClasses(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

reloadPackage	back to summary
public void reloadPackage(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.

removeListener	back to summary
public void removeListener(BshClassManager.Listener l)

reset	back to summary
public void reset() Clear all loaders and start over. No class loading.

setClassLoader	back to summary
public void setClassLoader(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.

setClassLoader

back to summary

public void setClassLoader(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.

setClassPath	back to summary
public void setClassPath(URL[] cp) throws UtilEvalError Set a new base classpath and create a new base classloader. This means all types change.

bsh back to summary

public Interface BshClassManager.Listener

Known Direct Implementers: bsh.BSHType, bsh.NameSpace

Method Summary

Modifier and Type	Method and Description
public void	classLoaderChanged()

Method Detail

classLoaderChanged	back to summary
public void classLoaderChanged()

bsh back to summary

pack-priv Class BshClassManager.SignatureKey

Class Inheritance

extends Object

java.lang.Object
bsh.BshClassManager.SignatureKey

SignatureKey serves as a hash of a method signature on a class for fast lookup of overloaded and general resolved Java methods.

Field Summary

Modifier and Type	Field and Description
pack-priv Class<T>	clas
pack-priv int	hashCode
pack-priv String	methodName
pack-priv Class<T>[]	types

Constructor Summary

Access	Constructor and Description
pack-priv	SignatureKey(Class<T> clas, String methodName, Class<T>[] types)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

clas	back to summary
pack-priv Class<T> clas

hashCode	back to summary
pack-priv int hashCode

methodName	back to summary
pack-priv String methodName

types	back to summary
pack-priv Class<T>[] types

Constructor Detail

SignatureKey	back to summary
pack-priv SignatureKey(Class<T> clas, String methodName, Class<T>[] types)

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object.

public Class BshClassManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface BshClassManager.Listener

Method Summary

Method Detail

pack-priv Class BshClassManager.SignatureKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail