Class URLClassLoader
- All Implemented Interfaces:
Closeable, AutoCloseable
public class URLClassLoader extends SecureClassLoader implements Closeable
jar: scheme URL (see JarURLConnection) is assumed to refer to a JAR file. Any file: scheme URL that ends with a '/' is assumed to refer to a directory. Otherwise, the URL is assumed to refer to a JAR file which will be opened as needed. This class loader supports the loading of classes and resources from the contents of a multi-release JAR file that is referred to by a given URL.
- Since:
- 1.2
Constructor Summary
| Constructor | Description |
|---|---|
URLClassLoader |
Constructs a new named URLClassLoader for the specified URLs. |
URLClassLoader |
Constructs a new named URLClassLoader for the specified URLs, parent class loader, and URLStreamHandlerFactory. |
URLClassLoader |
Constructs a new URLClassLoader for the specified URLs using the system class loader as the parent. |
URLClassLoader |
Constructs a new URLClassLoader for the given URLs. |
URLClassLoader |
Constructs a new URLClassLoader for the specified URLs, parent class loader, and URLStreamHandlerFactory. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
protected void |
addURL |
Appends the specified URL to the list of URLs to search for classes and resources. |
void |
close() |
Closes this URLClassLoader, so that it can no longer be used to load new classes or resources that are defined by this loader. |
protected Package |
definePackage |
Defines a new package by name in this URLClassLoader. |
protected Class |
findClass |
Finds and loads the class with the specified name from the URL search path. |
URL |
findResource |
Finds the resource with the specified name on the URL search path. |
Enumeration |
findResources |
Returns an Enumeration of URLs representing all of the resources on the URL search path having the specified name. |
protected PermissionCollection |
getPermissions |
Returns an empty Permission collection. |
InputStream |
getResourceAsStream |
Returns an input stream for reading the specified resource. |
URL[] |
getURLs() |
Returns the search path of URLs for loading classes and resources. |
static URLClassLoader |
newInstance |
Creates a new instance of URLClassLoader for the specified URLs and default parent class loader. |
static URLClassLoader |
newInstance |
Creates a new instance of URLClassLoader for the specified URLs and parent class loader. |
Methods declared in class SecureClassLoader
defineClass, defineClass
Methods declared in class ClassLoader
clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getName, getPackage, getPackages, getParent, getPlatformClassLoader, getResource, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, loadClass, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners
Constructor Details
URLClassLoader
public URLClassLoader(URL[] urls, ClassLoader parent)
jar: scheme URL is assumed to refer to a JAR file. Any file: scheme URL that ends with a '/' is assumed to refer to a directory. Otherwise, the URL is assumed to refer to a JAR file which will be downloaded and opened as needed.- API Note:
- If
parentis specified asnull(for the bootstrap class loader) then there is no guarantee that all platform classes are visible. See Run-time Built-in Class Loaders for information on the bootstrap class loader and other built-in class loaders. - Parameters:
-
urls- the URLs from which to load classes and resources -
parent- the parent class loader for delegation, can benullfor the bootstrap class loader - Throws:
-
NullPointerException- ifurlsor any of its elements isnull.
URLClassLoader
public URLClassLoader(URL[] urls)
- Parameters:
-
urls- the URLs from which to load classes and resources - Throws:
-
NullPointerException- ifurlsor any of its elements isnull.
URLClassLoader
public URLClassLoader(URL[] urls, ClassLoader parent, URLStreamHandlerFactory factory)
- API Note:
- If
parentis specified asnull(for the bootstrap class loader) then there is no guarantee that all platform classes are visible. See Run-time Built-in Class Loaders for information on the bootstrap class loader and other built-in class loaders. - Parameters:
-
urls- the URLs from which to load classes and resources -
parent- the parent class loader for delegation, can benullfor the bootstrap class loader -
factory- the URLStreamHandlerFactory to use when creating URLs - Throws:
-
NullPointerException- ifurlsor any of its elements isnull.
URLClassLoader
public URLClassLoader(String name, URL[] urls, ClassLoader parent)
URLClassLoader for the specified URLs. The URLs will be searched in the order specified for classes and resources after first searching in the specified parent class loader. Any URL that ends with a '/' is assumed to refer to a directory. Otherwise, the URL is assumed to refer to a JAR file which will be downloaded and opened as needed.- API Note:
- If
parentis specified asnull(for the bootstrap class loader) then there is no guarantee that all platform classes are visible. See Run-time Built-in Class Loaders for information on the bootstrap class loader and other built-in class loaders. - Parameters:
-
name- class loader name; ornullif not named -
urls- the URLs from which to load classes and resources -
parent- the parent class loader for delegation, can benullfor the bootstrap class loader - Throws:
-
IllegalArgumentException- if the given name is empty. -
NullPointerException- ifurlsor any of its elements isnull. - Since:
- 9
URLClassLoader
public URLClassLoader(String name, URL[] urls, ClassLoader parent, URLStreamHandlerFactory factory)
URLClassLoader for the specified URLs, parent class loader, and URLStreamHandlerFactory. The parent argument will be used as the parent class loader for delegation. The factory argument will be used as the stream handler factory to obtain protocol handlers when creating new jar URLs.- API Note:
- If
parentis specified asnull(for the bootstrap class loader) then there is no guarantee that all platform classes are visible. See Run-time Built-in Class Loaders for information on the bootstrap class loader and other built-in class loaders. - Parameters:
-
name- class loader name; ornullif not named -
urls- the URLs from which to load classes and resources -
parent- the parent class loader for delegation, can benullfor the bootstrap class loader -
factory- the URLStreamHandlerFactory to use when creating URLs - Throws:
-
IllegalArgumentException- if the given name is empty. -
NullPointerException- ifurlsor any of its elements isnull. - Since:
- 9
Method Details
getResourceAsStream
public InputStream getResourceAsStream(String name)
The search order is described in the documentation for ClassLoader.getResource(String).
- Overrides:
-
getResourceAsStreamin classClassLoader - Parameters:
-
name- The resource name - Returns:
- An input stream for reading the resource, or
nullif the resource could not be found - Throws:
-
NullPointerException- Ifnameisnull - Since:
- 1.7
close
public void close() throws IOException
In the case of jar: and file: URLs, it also closes any files that were opened by it. If another thread is loading a class when the close method is invoked, then the result of that load is undefined.
The method makes a best effort attempt to close all opened files, by catching IOExceptions internally. Unchecked exceptions and errors are not caught. Calling close on an already closed loader has no effect.
- Specified by:
-
closein interfaceAutoCloseable - Specified by:
-
closein interfaceCloseable - Throws:
-
IOException- if closing any file opened by this class loader resulted in an IOException. Any such exceptions are caught internally. If only one is caught, then it is re-thrown. If more than one exception is caught, then the second and following exceptions are added as suppressed exceptions of the first one caught, which is then re-thrown. - Since:
- 1.7
addURL
protected void addURL(URL url)
If the URL specified is null or is already in the list of URLs, or if this loader is closed, then invoking this method has no effect.
- Parameters:
-
url- the URL to be added to the search path of URLs
getURLs
public URL[] getURLs()
- Returns:
- the search path of URLs for loading classes and resources.
findClass
protected Class<?> findClass(String name) throws ClassNotFoundException
- Overrides:
-
findClassin classClassLoader - Parameters:
-
name- the name of the class - Returns:
- the resulting class
- Throws:
-
ClassNotFoundException- if the class could not be found, or if the loader is closed. -
NullPointerException- ifnameisnull.
definePackage
protected Package definePackage(String name, Manifest man, URL url)
URLClassLoader. The attributes contained in the specified Manifest will be used to obtain package version and sealing information. For sealed packages, the additional URL specifies the code source URL from which the package was loaded.- Parameters:
-
name- the package name -
man- theManifestcontaining package version and sealing information -
url- the code source url for the package, or null if none - Returns:
- the newly defined
Packageobject - Throws:
-
IllegalArgumentException- if the package name is already defined by this class loader
findResource
public URL findResource(String name)
- Overrides:
-
findResourcein classClassLoader - Parameters:
-
name- the name of the resource - Returns:
- a
URLfor the resource, ornullif the resource could not be found, or if the loader is closed.
findResources
public Enumeration<URL> findResources(String name) throws IOException
- Overrides:
-
findResourcesin classClassLoader - Parameters:
-
name- the resource name - Returns:
- An
EnumerationofURLs. If the loader is closed, the Enumeration contains no elements. - Throws:
-
IOException- if an I/O exception occurs
getPermissions
protected PermissionCollection getPermissions(CodeSource codesource)
- Overrides:
-
getPermissionsin classSecureClassLoader - Parameters:
-
codesource- theCodeSource - Returns:
- an empty Permission collection
- Throws:
-
NullPointerException- ifcodesourceisnull.
newInstance
public static URLClassLoader newInstance(URL[] urls, ClassLoader parent)
- Parameters:
-
urls- the URLs to search for classes and resources -
parent- the parent class loader for delegation - Returns:
- the resulting class loader
- Throws:
-
NullPointerException- ifurlsor any of its elements isnull.
newInstance
public static URLClassLoader newInstance(URL[] urls)
- Parameters:
-
urls- the URLs to search for classes and resources - Returns:
- the resulting class loader
- Throws:
-
NullPointerException- ifurlsor any of its elements isnull.
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/net/URLClassLoader.html