| public abstract class java.lang ClassLoader
|
Java SE 6 |
Every Class object contains a reference to the ClassLoader that defined
it.
Class objects for array classes are not created by class
loaders, but are created automatically as required by the Java runtime.
The class loader for an array class, as returned by Class#getClassLoader() is the same as the class loader for its element
type; if the element type is a primitive type, then the array class has no
class loader.
Applications implement subclasses of ClassLoader in order to extend the manner in which the Java virtual machine dynamically loads classes.
Class loaders may typically be used by security managers to indicate security domains.
The ClassLoader class uses a delegation model to search for classes and resources. Each instance of ClassLoader has an associated parent class loader. When requested to find a class or resource, a ClassLoader instance will delegate the search for the class or resource to its parent class loader before attempting to find the class or resource itself. The virtual machine's built-in class loader, called the "bootstrap class loader", does not itself have a parent but may serve as the parent of a ClassLoader instance.
Normally, the Java virtual machine loads classes from the local file system in a platform-dependent manner. For example, on UNIX systems, the virtual machine loads classes from the directory defined by the CLASSPATH environment variable.
However, some classes may not originate from a file; they may originate
from other sources, such as the network, or they could be constructed by an
application. The method defineClass converts an array of bytes into an instance of class
Class. Instances of this newly defined class can be created using
Class.newInstance.
The methods and constructors of objects created by a class loader may
reference other classes. To determine the class(es) referred to, the Java
virtual machine invokes the loadClass method of
the class loader that originally created the class.
For example, an application could create a network class loader to download class files from a server. Sample code might look like:
ClassLoader loader = new NetworkClassLoader(host, port);
Object main = loader.loadClass("Main", true).newInstance();
. . .
The network class loader subclass must define the methods findClass and loadClassData to load a class
from the network. Once it has downloaded the bytes that make up the class,
it should use the method defineClass to
create a class instance. A sample implementation is:
class NetworkClassLoader extends ClassLoader {
String host;
int port;
public Class findClass(String name) {
byte[] b = loadClassData(name);
return defineClass(name, b, 0, b.length);
}
private byte[] loadClassData(String name) {
// load the class data from the connection
. . .
}
}
Any class name provided as a String parameter to methods in
ClassLoader must be a binary name as defined by the Java Language Specification.
Examples of valid class names include:
"java.lang.String" "javax.swing.JSpinner$DefaultEditor" "java.security.KeyStore$Builder$FileBuilder$1" "java.net.URLClassLoader$3$1"
| version | 1.189, 11/17/05 |
| since | 1.0 |
| See also | resolveClass(Class) |
| Constructors | |||||||
|---|---|---|---|---|---|---|---|
| protected | ClassLoader(ClassLoader parent) Creates a new class loader using the specified parent class loader for delegation. If there is a security manager, its
| ||||||
| protected | ClassLoader() Creates a new class loader using the ClassLoader returned by the method getSystemClassLoader() as the parent class loader.
If there is a security manager, its
| ||||||
| Methods | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | clearAssertionStatus() Sets the default assertion status for this class loader to false and discards any package defaults or class assertion status settings associated with the class loader. This method is provided so that class loaders can be made to ignore any command line or persistent assertion status settings and "start with a clean slate."
| ||||||||||||||||||||||
| final protected Class | defineClass(byte[] b, int off, int len) throws ClassFormatError Converts an array of bytes into an instance of class Class. Before the Class can be used it must be resolved. This method is deprecated in favor of the version that takes a binary name as its first argument, and is more secure.
| ||||||||||||||||||||||
| final protected Class | defineClass(String name, byte[] b, int off, int len) throws ClassFormatError Converts an array of bytes into an instance of class Class. Before the Class can be used it must be resolved. This method assigns a default To assign a specific ProtectionDomain to the class, use
the
| ||||||||||||||||||||||
| final protected Class | defineClass(String name, byte[] b, int off, int len, ProtectionDomain protectionDomain) throws ClassFormatError Converts an array of bytes into an instance of class Class, with an optional ProtectionDomain. If the domain is null, then a default domain will be assigned to the class as specified in the documentation for byte[],
int, int). Before the class can be used it must be resolved.
The first class defined in a package determines the exact set of
certificates that all subsequent classes defined in that package must
contain. The set of certificates for a class is obtained from the
The specified name cannot begin with "java.", since
all classes in the "java.* packages can only be defined by the
bootstrap class loader. If name is not null, it
must be equal to the binary name of the class
specified by the byte array "b", otherwise a
| ||||||||||||||||||||||
| final protected Class | defineClass(String name, java.nio.ByteBuffer b, ProtectionDomain protectionDomain) throws ClassFormatError Converts a ByteBuffer
into an instance of class Class,
with an optional ProtectionDomain. If the domain is
null, then a default domain will be assigned to the class as
specified in the documentation for byte[],
int, int). Before the class can be used it must be resolved.
The rules about the first class defined in a package determining the set of
certificates for the package, and the restrictions on class names are identical
to those specified in the documentation for An invocation of this method of the form cl.defineClass(name, bBuffer, pd) yields exactly the same result as the statements ...
| ||||||||||||||||||||||
| protected Package | definePackage(String name, String specTitle, String specVersion, String specVendor, String implTitle, String implVersion, String implVendor, URL sealBase) throws IllegalArgumentException Defines a package by name in this ClassLoader. This allows class loaders to define the packages for their classes. Packages must be created before the class is defined, and package names must be unique within a class loader and cannot be redefined or changed once created.
| ||||||||||||||||||||||
| protected Class | findClass(String name) throws ClassNotFoundException Finds the class with the specified binary name. This method should be overridden by class loader implementations that follow the delegation model for loading classes, and will be invoked by the loadClass method after checking the
parent class loader for the requested class. The default implementation
throws a ClassNotFoundException.
| ||||||||||||||||||||||
| protected String | findLibrary(String libname) Returns the absolute path name of a native library. The VM invokes this method to locate the native libraries that belong to classes loaded with this class loader. If this method returns null, the VM searches the library along the path specified as the "java.library.path" property.
| ||||||||||||||||||||||
| final protected Class | findLoadedClass(String name) Returns the class with the given binary name if this loader has been recorded by the Java virtual machine as an initiating loader of a class with that binary name. Otherwise null is returned.
| ||||||||||||||||||||||
| protected URL | findResource(String name) Finds the resource with the given name. Class loader implementations should override this method to specify where to find resources.
| ||||||||||||||||||||||
| protected Enumeration | findResources(String name) throws IOException Returns an enumeration of URL objects
representing all the resources with the given name. Class loader
implementations should override this method to specify where to load
resources from.
| ||||||||||||||||||||||
| final protected Class | findSystemClass(String name) throws ClassNotFoundException Finds a class with the specified binary name, loading it if necessary. This method loads the class through the system class loader (see
| ||||||||||||||||||||||
| public Class | loadClass(String name) throws ClassNotFoundException Loads the class with the specified binary name. This method searches for classes in the same manner as the boolean) method. It is invoked by the Java virtual
machine to resolve class references. Invoking this method is equivalent
to invoking loadClass(name,
false).
| ||||||||||||||||||||||
| protected Class | loadClass(String name, boolean resolve) throws ClassNotFoundException Loads the class with the specified binary name. The default implementation of this method searches for classes in the following order:
If the class was found using the above steps, and the
resolve flag is true, this method will then invoke the Subclasses of ClassLoader are encouraged to override
| ||||||||||||||||||||||
| final protected void | resolveClass(Class c) Links the specified class. This (misleadingly named) method may be used by a class loader to link a class. If the class c has already been linked, then this method simply returns. Otherwise, the class is linked as described in the "Execution" chapter of the Java Language Specification.
| ||||||||||||||||||||||
| Properties | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public void | setClassAssertionStatus(String className, boolean enabled) Sets the desired assertion status for the named top-level class in this class loader and any nested classes contained therein. This setting takes precedence over the class loader's default assertion status, and over any applicable per-package default. This method has no effect if the named class has already been initialized. (Once a class is initialized, its assertion status cannot change.) If the named class is not a top-level class, this invocation will have no effect on the actual assertion status of any class.
| ||||||||||
| public void | setDefaultAssertionStatus(boolean enabled) Sets the default assertion status for this class loader. This setting determines whether classes loaded by this class loader and initialized in the future will have assertions enabled or disabled by default. This setting may be overridden on a per-package or per-class basis by invoking boolean) or boolean).
| ||||||||||
| protected Package | getPackage(String name) Returns a Package that has been defined by this class loader or any of its ancestors.
| ||||||||||
| public void | setPackageAssertionStatus(String packageName, boolean enabled) Sets the package default assertion status for the named package. The package default assertion status determines the assertion status for classes initialized in the future that belong to the named package or any of its "subpackages". A subpackage of a package named p is any package whose name begins with "p.". For example, javax.swing.text is a subpackage of javax.swing, and both java.util and java.lang.reflect are subpackages of java. In the event that multiple package defaults apply to a given class, the package default pertaining to the most specific package takes precedence over the others. For example, if javax.lang and javax.lang.reflect both have package defaults associated with them, the latter package default applies to classes in javax.lang.reflect. Package defaults take precedence over the class loader's default
assertion status, and may be overridden on a per-class basis by invoking
| ||||||||||
| protected Package[] | getPackages() Returns all of the Packages defined by this class loader and its ancestors.
| ||||||||||
| final public ClassLoader | getParent() Returns the parent class loader for delegation. Some implementations may use null to represent the bootstrap class loader. This method will return null in such implementations if this class loader's parent is the bootstrap class loader. If a security manager is present, and the invoker's class loader is
not null and is not an ancestor of this class loader, then this
method invokes the security manager's
| ||||||||||
| public URL | getResource(String name) 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. The name of a resource is a '/'-separated path name that identifies the resource. This method will first search the parent class loader for the
resource; if the parent is null the path of the class loader
built-in to the virtual machine is searched. That failing, this method
will invoke
| ||||||||||
| public InputStream | getResourceAsStream(String name) Returns an input stream for reading the specified resource. The search order is described in the documentation for
| ||||||||||
| public Enumeration | getResources(String name) throws IOException Finds all the resources 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. The name of a resource is a /-separated path name that identifies the resource. The search order is described in the documentation for
| ||||||||||
| final protected void | setSigners(Class c, Object[] signers) Sets the signers of a class. This should be invoked after defining a class.
| ||||||||||
| public static ClassLoader | getSystemClassLoader() Returns the system class loader for delegation. This is the default delegation parent for new ClassLoader instances, and is typically the class loader used to start the application. This method is first invoked early in the runtime's startup sequence, at which point it creates the system class loader and sets it as the context class loader of the invoking Thread. The default system class loader is an implementation-dependent instance of this class. If the system property "java.system.class.loader" is defined when this method is first invoked then the value of that property is taken to be the name of a class that will be returned as the system class loader. The class is loaded using the default system class loader and must define a public constructor that takes a single parameter of type ClassLoader which is used as the delegation parent. An instance is then created using this constructor with the default system class loader as the parameter. The resulting class loader is defined to be the system class loader. If a security manager is present, and the invoker's class loader is
not null and the invoker's class loader is not the same as or
an ancestor of the system class loader, then this method invokes the
security manager's
| ||||||||||
| public static URL | getSystemResource(String name) Find a resource of the specified name from the search path used to load classes. This method locates the resource through the system class loader (see #getSystemClassLoader()).
| ||||||||||
| public static InputStream | getSystemResourceAsStream(String name) Open for reading, a resource of the specified name from the search path used to load classes. This method locates the resource through the system class loader (see #getSystemClassLoader()).
| ||||||||||
| public static Enumeration | getSystemResources(String name) throws IOException Finds all resources of the specified name from the search path used to load classes. The resources thus found are returned as an Enumeration of URL objects.
The search order is described in the documentation for
| ||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|