bsh.classpath

Class BshClassPath

java.lang.Object

bsh.classpath.BshClassPath

All Implemented Interfaces:

ClassPathListener, NameSource

public class BshClassPath
extends java.lang.Object
implements ClassPathListener, NameSource

A BshClassPath encapsulates knowledge about a class path of URLs. It can maps all classes the path which may include: jar/zip files and base dirs A BshClassPath may composite other BshClassPaths as components of its path and will reflect changes in those components through its methods and listener interface. Classpath traversal is done lazily when a call is made to getClassesForPackage() or getClassSource() or can be done explicitily through insureInitialized(). Feedback on mapping progress is provided through the MappingFeedback interface. Design notes: Several times here we traverse ourselves and our component paths to produce a composite view of some thing relating to the path. This would be an opportunity for a visitor pattern.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BshClassPath.AmbiguousName
static class	BshClassPath.ClassSource
static class	BshClassPath.DirClassSource
static class	BshClassPath.GeneratedClassSource
static class	BshClassPath.JarClassSource
static class	BshClassPath.JrtClassSource

Nested classes/interfaces inherited from interface bsh.NameSource

NameSource.Listener

Constructor Summary

Constructors

Constructor and Description
BshClassPath(java.lang.String name)
BshClassPath(java.lang.String name, java.net.URL[] urls)

Method Summary

Modifier and Type	Method and Description
void	add(java.net.URL url)
void	add(java.net.URL[] urls)
void	addComponent(BshClassPath bcp) Add the specified BshClassPath as a component of our path.
void	addListener(ClassPathListener l)
static void	addMappingFeedback(bsh.classpath.BshClassPath.MappingFeedback mf) Add a mapping feedback callback class.
void	addNameSourceListener(NameSource.Listener listener) Implements NameSource Add a listener who is notified upon changes to names in this space.
static java.lang.String	canonicalizeClassName(java.lang.String name)
void	classPathChanged()
static java.net.URL[]	expand(java.net.URL[] urls)
java.lang.String[]	getAllNames()
static BshClassPath	getBootClassPath()
java.util.Set<java.lang.String>	getClassesForPackage(java.lang.String pack) Return the set of class names in the specified package including all component paths.
java.lang.String	getClassNameByUnqName(java.lang.String name) Support for super import "*"; Get the full name associated with the unqualified name in this classpath.
BshClassPath.ClassSource	getClassSource(java.lang.String className) Return the source of the specified class which may lie in component path.
protected java.util.List<java.net.URL>	getFullPath() Get the full path including component paths.
java.util.List<NameSource.Listener>	getNameSourceListeners() Get the name source listeners list.
java.util.Set<java.lang.String>	getPackagesSet() Get a list of all of the known packages
java.net.URL[]	getPathComponents() Get the path components including any component paths.
bsh.classpath.BshClassPath.UnqualifiedNameTable	getUnqNameTable() Get the unqualified name table.
static BshClassPath	getUserClassPath()
static java.net.URL[]	getUserClassPathComponents()
void	insureInitialized() If the claspath map is not initialized, do it now.
protected void	insureInitialized(boolean topPath) This is the top level classpath component.
static boolean	isArchiveFileName(java.lang.String name)
static boolean	isClassFileName(java.lang.String name)
boolean	isMapsInitialized() Whether map is initialized.
boolean	isNameCompletionIncludesUnqNames() Whether name completion includes unqualified names.
static java.util.Collection<java.lang.String>	removeInnerClassNames(java.util.Collection<java.lang.String> col) Return a new collection without any inner class names
void	removeListener(ClassPathListener l)
void	setClassSource(java.lang.String className, BshClassPath.ClassSource cs) Explicitly set a class source.
void	setMapsInitialized(boolean mapsInitialized) Change whether map is initialized.
void	setNameCompletionIncludesUnqNames(boolean nameCompletionIncludesUnqNames) Change whether name completion includes unqualified names.
void	setNameSourceListeners(java.util.List<NameSource.Listener> nameSourceListeners) Change the name source listeners list.
void	setPath(java.net.URL[] urls)
void	setUnqNameTable(bsh.classpath.BshClassPath.UnqualifiedNameTable unqNameTable) Change the unqualified name table.
static java.lang.String[]	splitClassname(java.lang.String classname)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BshClassPath

public BshClassPath(java.lang.String name)

BshClassPath

public BshClassPath(java.lang.String name,
                    java.net.URL[] urls)

Method Detail

setPath

public void setPath(java.net.URL[] urls)

addComponent

public void addComponent(BshClassPath bcp)

Add the specified BshClassPath as a component of our path. Changes in the bcp will be reflected through us.

add

public void add(java.net.URL[] urls)

add

public void add(java.net.URL url)
         throws java.io.IOException

Throws:

java.io.IOException

expand

public static java.net.URL[] expand(java.net.URL[] urls)

getPathComponents

public java.net.URL[] getPathComponents()

Get the path components including any component paths.

getClassesForPackage

public java.util.Set<java.lang.String> getClassesForPackage(java.lang.String pack)

Return the set of class names in the specified package including all component paths.

getClassSource

public BshClassPath.ClassSource getClassSource(java.lang.String className)

Return the source of the specified class which may lie in component path.

setClassSource

public void setClassSource(java.lang.String className,
                           BshClassPath.ClassSource cs)

Explicitly set a class source. This is used for generated classes, but could potentially be used to allow a user to override which version of a class from the classpath is located.

insureInitialized

public void insureInitialized()

If the claspath map is not initialized, do it now. If component maps are not do them as well... Random note: Should this be "insure" or "ensure". I know I've seen "ensure" used in the JDK source. Here's what Webster has to say: Main Entry:ensure Pronunciation:in-'shur Function:transitive verb Inflected Form(s):ensured; ensuring : to make sure, certain, or safe : GUARANTEE synonyms ENSURE, INSURE, ASSURE, SECURE mean to make a thing or person sure. ENSURE, INSURE, and ASSURE are interchangeable in many contexts where they indicate the making certain or inevitable of an outcome, but INSURE sometimes stresses the taking of necessary measures beforehand, and ASSURE distinctively implies the removal of doubt and suspense from a person's mind. SECURE implies action taken to guard against attack or loss.

insureInitialized

protected void insureInitialized(boolean topPath)

This is the top level classpath component.

Parameters:

topPath - the start Class Mapping message

getFullPath

protected java.util.List<java.net.URL> getFullPath()

Get the full path including component paths. (component paths listed first, in order) Duplicate path components are removed.

getClassNameByUnqName

public java.lang.String getClassNameByUnqName(java.lang.String name)
                                       throws ClassPathException

Support for super import "*"; Get the full name associated with the unqualified name in this classpath. Returns either the String name or an AmbiguousName object encapsulating the various names.

Throws:

ClassPathException

getAllNames

public java.lang.String[] getAllNames()

Specified by:

getAllNames in interface NameSource

classPathChanged

public void classPathChanged()

Specified by:

classPathChanged in interface ClassPathListener

isClassFileName

public static boolean isClassFileName(java.lang.String name)

isArchiveFileName

public static boolean isArchiveFileName(java.lang.String name)

canonicalizeClassName

public static java.lang.String canonicalizeClassName(java.lang.String name)

splitClassname

public static java.lang.String[] splitClassname(java.lang.String classname)

removeInnerClassNames

public static java.util.Collection<java.lang.String> removeInnerClassNames(java.util.Collection<java.lang.String> col)

Return a new collection without any inner class names

getUserClassPathComponents

public static java.net.URL[] getUserClassPathComponents()
                                                 throws ClassPathException

Throws:

ClassPathException

getPackagesSet

public java.util.Set<java.lang.String> getPackagesSet()

Get a list of all of the known packages

addListener

public void addListener(ClassPathListener l)

removeListener

public void removeListener(ClassPathListener l)

getUserClassPath

public static BshClassPath getUserClassPath()
                                     throws ClassPathException

Throws:

ClassPathException

getBootClassPath

public static BshClassPath getBootClassPath()
                                     throws ClassPathException

Throws:

ClassPathException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addNameSourceListener

public void addNameSourceListener(NameSource.Listener listener)

Implements NameSource Add a listener who is notified upon changes to names in this space.

Specified by:

addNameSourceListener in interface NameSource

addMappingFeedback

public static void addMappingFeedback(bsh.classpath.BshClassPath.MappingFeedback mf)

Add a mapping feedback callback class. If one already exists a runtime exception is thrown.

Parameters:

mf - the mapping feedback callback listener.

isMapsInitialized

public boolean isMapsInitialized()

Whether map is initialized.

Returns:

boolean return the mapsInitialized

setMapsInitialized

public void setMapsInitialized(boolean mapsInitialized)

Change whether map is initialized.

Parameters:

mapsInitialized - the mapsInitialized to set

getUnqNameTable

public bsh.classpath.BshClassPath.UnqualifiedNameTable getUnqNameTable()

Get the unqualified name table.

Returns:

UnqualifiedNameTable return the unqNameTable

setUnqNameTable

public void setUnqNameTable(bsh.classpath.BshClassPath.UnqualifiedNameTable unqNameTable)

Change the unqualified name table.

Parameters:

unqNameTable - the unqNameTable to set

isNameCompletionIncludesUnqNames

public boolean isNameCompletionIncludesUnqNames()

Whether name completion includes unqualified names.

Returns:

boolean return the nameCompletionIncludesUnqNames

setNameCompletionIncludesUnqNames

public void setNameCompletionIncludesUnqNames(boolean nameCompletionIncludesUnqNames)

Change whether name completion includes unqualified names.

Parameters:

nameCompletionIncludesUnqNames - the nameCompletionIncludesUnqNames to set

getNameSourceListeners

public java.util.List<NameSource.Listener> getNameSourceListeners()

Get the name source listeners list.

Returns:

List<NameSource.Listener> return the nameSourceListeners

setNameSourceListeners

public void setNameSourceListeners(java.util.List<NameSource.Listener> nameSourceListeners)

Change the name source listeners list.

Parameters:

nameSourceListeners - the nameSourceListeners to set