| java.lang.Object
 java.lang.ClassLoader
org.apache.tools.ant.AntClassLoader
All known Subclasses: org.apache.tools.ant.loader.AntClassLoader2,
| AntClassLoader | | public class AntClassLoader extends ClassLoader implements SubBuildListener(Code) | | Used to load classes within ant with a different classpath from
that used to start ant. Note that it is possible to force a class
into this loader even when that class is on the system classpath by
using the forceLoadClass method. Any subsequent classes loaded by that
class will then use this loader rather than the system class loader.
Note that this classloader has a feature to allow loading
in reverse order and for "isolation".
Due to the fact that a number of
methods in java.lang.ClassLoader are final (at least
in java 1.4 getResources) this means that the
class has to fake the given parent.
|
| Constructor Summary | |
| public | AntClassLoader(ClassLoader parent, Project project, Path classpath)
Create an Ant ClassLoader for a given project, with
a parent classloader and an initial classpath. | | public | AntClassLoader()
| | public | AntClassLoader(Project project, Path classpath)
Creates a classloader for the given project using the classpath given.
Parameters:
project - The project to which this classloader is to belong.Must not be null.
Parameters:
classpath - The classpath to use to load the classes. | | public | AntClassLoader(ClassLoader parent, Project project, Path classpath, boolean parentFirst)
Creates a classloader for the given project using the classpath given.
Parameters:
parent - The parent classloader to which unsatisfied loadingattempts are delegated. | | public | AntClassLoader(Project project, Path classpath, boolean parentFirst)
Creates a classloader for the given project using the classpath given.
Parameters:
project - The project to which this classloader is to belong.Must not be null.
Parameters:
classpath - The classpath to use to load the classes. | | public | AntClassLoader(ClassLoader parent, boolean parentFirst)
Creates an empty class loader. |
| Method Summary | |
| public void | addJavaLibraries()
| | public void | addLoaderPackageRoot(String packageRoot)
Adds a package root to the list of packages which must be loaded using
this loader. | | public void | addPathElement(String pathElement)
Adds an element to the classpath to be searched.
Parameters:
pathElement - The path element to add. | | protected void | addPathFile(File pathComponent)
Add a file to the path. | | public void | addSystemPackageRoot(String packageRoot)
Adds a package root to the list of packages which must be loaded on the
parent loader. | | public void | buildFinished(BuildEvent event)
Cleans up any resources held by this classloader at the end
of a build. | | public void | buildStarted(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public synchronized void | cleanup()
Cleans up any resources held by this classloader. | | protected Class | defineClassFromData(File container, byte[] classData, String classname)
| | protected void | definePackage(File container, String className)
Define the package information associated with a class. | | protected void | definePackage(File container, String packageName, Manifest manifest)
| | public Class | findClass(String name)
Searches for and load a class on the classpath of this class loader.
Parameters:
name - The name of the class to be loaded. | | protected Enumeration | findResources(String name)
Returns an enumeration of URLs representing all the resources with the
given name by searching the class loader's classpath.
Parameters:
name - The resource name to search for.Must not be null. | | public Class | forceLoadClass(String classname)
Loads a class through this class loader even if that class is available
on the parent classpath.
This ensures that any classes which are loaded by the returned class
will use this classloader.
Parameters:
classname - The name of the class to be loaded.Must not be null. | | public Class | forceLoadSystemClass(String classname)
Loads a class through this class loader but defer to the parent class
loader.
This ensures that instances of the returned class will be compatible
with instances which have already been loaded on the parent
loader.
Parameters:
classname - The name of the class to be loaded.Must not be null. | | public String | getClasspath()
Returns the classpath this classloader will consult. | | public URL | getResource(String name)
Finds the resource with the given name. | | public InputStream | getResourceAsStream(String name)
Returns a stream to read the requested resource name.
Parameters:
name - The name of the resource for which a stream is required.Must not be null. | | protected URL | getResourceURL(File file, String resourceName)
Returns the URL of a given resource in the given file which may
either be a directory or a zip file.
Parameters:
file - The file (directory or jar) in which to search forthe resource. | | public static void | initializeClass(Class theClass)
Forces initialization of a class in a JDK 1.1 compatible, albeit hacky
way. | | protected boolean | isInPath(File component)
| | protected synchronized Class | loadClass(String classname, boolean resolve)
Loads a class with this class loader.
This class attempts to load the class in an order determined by whether
or not the class matches the system/loader package lists, with the
loader package list taking priority. | | protected void | log(String message, int priority)
Logs a message through the project object if one has been provided. | | public void | messageLogged(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public void | resetThreadContextLoader()
Resets the current thread's context loader to its original value. | | public void | setClassPath(Path classpath)
Set the classpath to search for classes to load. | | public synchronized void | setIsolated(boolean isolated)
Sets whether this classloader should run in isolated mode. | | public void | setParent(ClassLoader parent)
Set the parent for this class loader. | | public void | setParentFirst(boolean parentFirst)
Control whether class lookup is delegated to the parent loader first
or after this loader. | | public void | setProject(Project project)
| | public void | setThreadContextLoader()
Sets the current thread's context loader to this classloader, storing
the current loader value for later resetting. | | public void | subBuildFinished(BuildEvent event)
Cleans up any resources held by this classloader at the end of
a subbuild if it has been created for the subbuild's project
instance. | | public void | subBuildStarted(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public void | targetFinished(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public void | targetStarted(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public void | taskFinished(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public void | taskStarted(BuildEvent event)
Empty implementation to satisfy the BuildListener interface. | | public String | toString()
Returns a String representing this loader. |
| AntClassLoader | | public AntClassLoader(ClassLoader parent, Project project, Path classpath)(Code) | | Create an Ant ClassLoader for a given project, with
a parent classloader and an initial classpath.
since:
Ant 1.7.
Parameters:
parent - the parent for this classloader.
Parameters:
project - The project to which this classloader is tobelong.
Parameters:
classpath - The classpath to use to load classes. |
| AntClassLoader | | public AntClassLoader()(Code) | | Create an Ant Class Loader
|
| AntClassLoader | | public AntClassLoader(Project project, Path classpath)(Code) | | Creates a classloader for the given project using the classpath given.
Parameters:
project - The project to which this classloader is to belong.Must not be null.
Parameters:
classpath - The classpath to use to load the classes. Thisis combined with the system classpath in a mannerdetermined by the value of ${build.sysclasspath}.May be null, in which case no pathelements are set up to start with. |
| AntClassLoader | | public AntClassLoader(ClassLoader parent, Project project, Path classpath, boolean parentFirst)(Code) | | Creates a classloader for the given project using the classpath given.
Parameters:
parent - The parent classloader to which unsatisfied loadingattempts are delegated. May be null,in which case the classloader which loaded thisclass is used as the parent.
Parameters:
project - The project to which this classloader is to belong.Must not be null.
Parameters:
classpath - the classpath to use to load the classes.May be null, in which case no pathelements are set up to start with.
Parameters:
parentFirst - If true, indicates that the parentclassloader should be consulted before trying toload the a class through this loader. |
| AntClassLoader | | public AntClassLoader(Project project, Path classpath, boolean parentFirst)(Code) | | Creates a classloader for the given project using the classpath given.
Parameters:
project - The project to which this classloader is to belong.Must not be null.
Parameters:
classpath - The classpath to use to load the classes. May benull, in which case no pathelements are set up to start with.
Parameters:
parentFirst - If true, indicates that the parentclassloader should be consulted before trying toload the a class through this loader. |
| AntClassLoader | | public AntClassLoader(ClassLoader parent, boolean parentFirst)(Code) | | Creates an empty class loader. The classloader should be configured
with path elements to specify where the loader is to look for
classes.
Parameters:
parent - The parent classloader to which unsatisfied loadingattempts are delegated. May be null,in which case the classloader which loaded thisclass is used as the parent.
Parameters:
parentFirst - If true, indicates that the parentclassloader should be consulted before trying toload the a class through this loader. |
| addJavaLibraries | | public void addJavaLibraries()(Code) | | add any libraries that come with different java versions
here
|
| addLoaderPackageRoot | | public void addLoaderPackageRoot(String packageRoot)(Code) | | Adds a package root to the list of packages which must be loaded using
this loader.
All subpackages are also included.
Parameters:
packageRoot - The root of all packages to be included.Should not be null. |
| addPathElement | | public void addPathElement(String pathElement) throws BuildException(Code) | | Adds an element to the classpath to be searched.
Parameters:
pathElement - The path element to add. Must not benull.
exception:
BuildException - if the given path element cannot be resolvedagainst the project. |
| addPathFile | | protected void addPathFile(File pathComponent) throws IOException(Code) | | Add a file to the path.
Reads the manifest, if available, and adds any additional class path jars
specified in the manifest.
Parameters:
pathComponent - the file which is to be added to the path forthis class loader
throws:
IOException - if data needed from the file cannot be read. |
| addSystemPackageRoot | | public void addSystemPackageRoot(String packageRoot)(Code) | | Adds a package root to the list of packages which must be loaded on the
parent loader.
All subpackages are also included.
Parameters:
packageRoot - The root of all packages to be included.Should not be null. |
| buildFinished | | public void buildFinished(BuildEvent event)(Code) | | Cleans up any resources held by this classloader at the end
of a build.
Parameters:
event - the buildFinished event |
| buildStarted | | public void buildStarted(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the buildStarted event |
| cleanup | | public synchronized void cleanup()(Code) | | Cleans up any resources held by this classloader. Any open archive
files are closed.
|
| defineClassFromData | | protected Class defineClassFromData(File container, byte[] classData, String classname) throws IOException(Code) | | Define a class given its bytes
Parameters:
container - the container from which the class data has been readmay be a directory or a jar/zip file.
Parameters:
classData - the bytecode data for the class
Parameters:
classname - the name of the class the Class instance created from the given data
throws:
IOException - if the class data cannot be read. |
| definePackage | | protected void definePackage(File container, String className) throws IOException(Code) | | Define the package information associated with a class.
Parameters:
container - the file containing the class definition.
Parameters:
className - the class name of for which the package informationis to be determined.
exception:
IOException - if the package information cannot be read from thecontainer. |
| definePackage | | protected void definePackage(File container, String packageName, Manifest manifest)(Code) | | Define the package information when the class comes from a
jar with a manifest
Parameters:
container - the jar file containing the manifest
Parameters:
packageName - the name of the package being defined.
Parameters:
manifest - the jar's manifest |
| findClass | | public Class findClass(String name) throws ClassNotFoundException(Code) | | Searches for and load a class on the classpath of this class loader.
Parameters:
name - The name of the class to be loaded. Must not benull. the required Class object
exception:
ClassNotFoundException - if the requested class does not existon this loader's classpath. |
| findResources | | protected Enumeration findResources(String name) throws IOException(Code) | | Returns an enumeration of URLs representing all the resources with the
given name by searching the class loader's classpath.
Parameters:
name - The resource name to search for.Must not be null. an enumeration of URLs for the resources
exception:
IOException - if I/O errors occurs (can't happen) |
| forceLoadClass | | public Class forceLoadClass(String classname) throws ClassNotFoundException(Code) | | Loads a class through this class loader even if that class is available
on the parent classpath.
This ensures that any classes which are loaded by the returned class
will use this classloader.
Parameters:
classname - The name of the class to be loaded.Must not be null. the required Class object
exception:
ClassNotFoundException - if the requested class does not existon this loader's classpath. |
| forceLoadSystemClass | | public Class forceLoadSystemClass(String classname) throws ClassNotFoundException(Code) | | Loads a class through this class loader but defer to the parent class
loader.
This ensures that instances of the returned class will be compatible
with instances which have already been loaded on the parent
loader.
Parameters:
classname - The name of the class to be loaded.Must not be null. the required Class object
exception:
ClassNotFoundException - if the requested class does not existon this loader's classpath. |
| getClasspath | | public String getClasspath()(Code) | | Returns the classpath this classloader will consult.
the classpath used for this classloader, with elementsseparated by the path separator for the system. |
| getResource | | public URL getResource(String name)(Code) | | Finds the resource with the given name. A resource is
some data (images, audio, text, etc) that can be accessed by class
code in a way that is independent of the location of the code.
Parameters:
name - The name of the resource for which a stream is required.Must not be null. a URL for reading the resource, or null if theresource could not be found or the caller doesn't haveadequate privileges to get the resource. |
| getResourceAsStream | | public InputStream getResourceAsStream(String name)(Code) | | Returns a stream to read the requested resource name.
Parameters:
name - The name of the resource for which a stream is required.Must not be null. a stream to the required resource or null if theresource cannot be found on the loader's classpath. |
| getResourceURL | | protected URL getResourceURL(File file, String resourceName)(Code) | | Returns the URL of a given resource in the given file which may
either be a directory or a zip file.
Parameters:
file - The file (directory or jar) in which to search forthe resource. Must not be null.
Parameters:
resourceName - The name of the resource for which a streamis required. Must not be null. a stream to the required resource or null if theresource cannot be found in the given file object. |
| initializeClass | | public static void initializeClass(Class theClass)(Code) | | Forces initialization of a class in a JDK 1.1 compatible, albeit hacky
way.
Parameters:
theClass - The class to initialize.Must not be null. |
| isInPath | | protected boolean isInPath(File component)(Code) | | Indicate if the given file is in this loader's path
Parameters:
component - the file which is to be checked true if the file is in the class path |
| loadClass | | protected synchronized Class loadClass(String classname, boolean resolve) throws ClassNotFoundException(Code) | | Loads a class with this class loader.
This class attempts to load the class in an order determined by whether
or not the class matches the system/loader package lists, with the
loader package list taking priority. If the classloader is in isolated
mode, failure to load the class in this loader will result in a
ClassNotFoundException.
Parameters:
classname - The name of the class to be loaded.Must not be null.
Parameters:
resolve - true if all classes upon which this classdepends are to be loaded. the required Class object
exception:
ClassNotFoundException - if the requested class does not existon the system classpath (when not in isolated mode) or this loader'sclasspath. |
| log | | protected void log(String message, int priority)(Code) | | Logs a message through the project object if one has been provided.
Parameters:
message - The message to log.Should not be null.
Parameters:
priority - The logging priority of the message. |
| messageLogged | | public void messageLogged(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the messageLogged event |
| resetThreadContextLoader | | public void resetThreadContextLoader()(Code) | | Resets the current thread's context loader to its original value.
|
| setClassPath | | public void setClassPath(Path classpath)(Code) | | Set the classpath to search for classes to load. This should not be
changed once the classloader starts to server classes
Parameters:
classpath - the search classpath consisting of directories andjar/zip files. |
| setIsolated | | public synchronized void setIsolated(boolean isolated)(Code) | | Sets whether this classloader should run in isolated mode. In
isolated mode, classes not found on the given classpath will
not be referred to the parent class loader but will cause a
ClassNotFoundException.
Parameters:
isolated - Whether or not this classloader should run inisolated mode. |
| setParent | | public void setParent(ClassLoader parent)(Code) | | Set the parent for this class loader. This is the class loader to which
this class loader will delegate to load classes
Parameters:
parent - the parent class loader. |
| setParentFirst | | public void setParentFirst(boolean parentFirst)(Code) | | Control whether class lookup is delegated to the parent loader first
or after this loader. Use with extreme caution. Setting this to
false violates the class loader hierarchy and can lead to Linkage errors
Parameters:
parentFirst - if true, delegate initial class search to the parentclassloader. |
| setProject | | public void setProject(Project project)(Code) | | Set the project associated with this class loader
Parameters:
project - the project instance |
| setThreadContextLoader | | public void setThreadContextLoader()(Code) | | Sets the current thread's context loader to this classloader, storing
the current loader value for later resetting.
|
| subBuildFinished | | public void subBuildFinished(BuildEvent event)(Code) | | Cleans up any resources held by this classloader at the end of
a subbuild if it has been created for the subbuild's project
instance.
Parameters:
event - the buildFinished event
since:
Ant 1.6.2 |
| subBuildStarted | | public void subBuildStarted(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the buildStarted event
since:
Ant 1.6.2 |
| targetFinished | | public void targetFinished(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the targetFinished event |
| targetStarted | | public void targetStarted(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the targetStarted event |
| taskFinished | | public void taskFinished(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the taskFinished event |
| taskStarted | | public void taskStarted(BuildEvent event)(Code) | | Empty implementation to satisfy the BuildListener interface.
Parameters:
event - the taskStarted event |
| toString | | public String toString()(Code) | | Returns a String representing this loader.
the path that this classloader has. |
| Methods inherited from java.lang.ClassLoader | public synchronized void clearAssertionStatus()(Code)(Java Doc)
final protected Class defineClass(byte[] b, int off, int len) throws ClassFormatError(Code)(Java Doc)
final protected Class defineClass(String name, byte[] b, int off, int len) throws ClassFormatError(Code)(Java Doc)
final protected Class defineClass(String name, byte[] b, int off, int len, ProtectionDomain protectionDomain) throws ClassFormatError(Code)(Java Doc)
final protected Class defineClass(String name, java.nio.ByteBuffer b, ProtectionDomain protectionDomain) throws ClassFormatError(Code)(Java Doc)
protected Package definePackage(String name, String specTitle, String specVersion, String specVendor, String implTitle, String implVersion, String implVendor, URL sealBase) throws IllegalArgumentException(Code)(Java Doc)
protected Class findClass(String name) throws ClassNotFoundException(Code)(Java Doc)
protected String findLibrary(String libname)(Code)(Java Doc)
final protected Class findLoadedClass(String name)(Code)(Java Doc)
protected URL findResource(String name)(Code)(Java Doc)
protected Enumeration<URL> findResources(String name) throws IOException(Code)(Java Doc)
final protected Class findSystemClass(String name) throws ClassNotFoundException(Code)(Java Doc)
protected Package getPackage(String name)(Code)(Java Doc)
protected Package[] getPackages()(Code)(Java Doc)
final public ClassLoader getParent()(Code)(Java Doc)
public URL getResource(String name)(Code)(Java Doc)
public InputStream getResourceAsStream(String name)(Code)(Java Doc)
public Enumeration<URL> getResources(String name) throws IOException(Code)(Java Doc)
public static ClassLoader getSystemClassLoader()(Code)(Java Doc)
public static URL getSystemResource(String name)(Code)(Java Doc)
public static InputStream getSystemResourceAsStream(String name)(Code)(Java Doc)
public static Enumeration<URL> getSystemResources(String name) throws IOException(Code)(Java Doc)
public Class loadClass(String name) throws ClassNotFoundException(Code)(Java Doc)
protected synchronized Class loadClass(String name, boolean resolve) throws ClassNotFoundException(Code)(Java Doc)
final protected void resolveClass(Class c)(Code)(Java Doc)
public synchronized void setClassAssertionStatus(String className, boolean enabled)(Code)(Java Doc)
public synchronized void setDefaultAssertionStatus(boolean enabled)(Code)(Java Doc)
public synchronized void setPackageAssertionStatus(String packageName, boolean enabled)(Code)(Java Doc)
final protected void setSigners(Class c, Object[] signers)(Code)(Java Doc)
|
|
|