Package io.quarkus.bootstrap.classloading

Class QuarkusClassLoader

java.lang.Object

java.lang.ClassLoader

io.quarkus.bootstrap.classloading.QuarkusClassLoader

All Implemented Interfaces:

Closeable, AutoCloseable

public class QuarkusClassLoader
extends ClassLoader
implements Closeable

The ClassLoader used for non production Quarkus applications (i.e. dev and test mode).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuarkusClassLoader.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	META_INF_SERVICES

Method Summary

Modifier and Type	Method	Description
void	addCloseTask(Runnable task)
static QuarkusClassLoader.Builder	builder(String name, ClassLoader parent, boolean parentFirst)
void	close()
protected Class<?>	findClass(String moduleName, String name)	This method is needed to make packages work correctly on JDK9+, as it will be called to load the package-info class.
protected URL	findResource(String name)
protected Enumeration<URL>	findResources(String name)
static List<ClassPathElement>	getElements(String resourceName, boolean onlyFromCurrentClassLoader)
List<ClassPathElement>	getElementsWithResource(String name)
List<ClassPathElement>	getElementsWithResource(String name, boolean localOnly)
String	getName()
Set<String>	getReloadableClassNames()
URL	getResource(String unsanitisedName)
InputStream	getResourceAsStream(String unsanitisedName)
Enumeration<URL>	getResources(String unsanitisedName)
Enumeration<URL>	getResources(String unsanitisedName, boolean parentAlreadyFoundResources)
static boolean	isApplicationClass(String className)	Indicates if a given class is considered an application class.
static boolean	isClassPresentAtRuntime(String className)	Indicates if a given class is present at runtime.
boolean	isClosed()
static boolean	isResourcePresentAtRuntime(String resourcePath)	Indicates if a given resource is present at runtime.
Class<?>	loadClass(String name)
protected Class<?>	loadClass(String name, boolean resolve)
ClassLoader	parent()
void	reset(Map<String,byte[]> generatedResources, Map<String,byte[]> transformedClasses)
String	toString()
Class<?>	visibleDefineClass(String name, byte[] b, int off, int len)
static void	visitRuntimeResources(String resourceName, Consumer<PathVisit> visitor)	Visits every found runtime resource with a given name.

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getPackage, getPackages, getParent, getPlatformClassLoader, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Field Details

META_INF_SERVICES

protected static final String META_INF_SERVICES

See Also:

• Constant Field Values

Method Details

visitRuntimeResources

public static void visitRuntimeResources(String resourceName,
 Consumer<PathVisit> visitor)

Visits every found runtime resource with a given name. If a resource is not found, the visitor will simply not be called.

IMPORTANT: this method works only when the current class loader is an instance of QuarkusClassLoader, otherwise it throws an error with the corresponding message.

Parameters:

resourceName - runtime resource name to visit

visitor - runtime resource visitor

getElements

public static List<ClassPathElement> getElements(String resourceName,
 boolean onlyFromCurrentClassLoader)

isClassPresentAtRuntime

public static boolean isClassPresentAtRuntime(String className)

Indicates if a given class is present at runtime.

Parameters:

className - the name of the class.

isApplicationClass

public static boolean isApplicationClass(String className)

Indicates if a given class is considered an application class.

isResourcePresentAtRuntime

public static boolean isResourcePresentAtRuntime(String resourcePath)

Indicates if a given resource is present at runtime. Can also be used to check if a class is present as a class is just a regular resource.

Parameters:

resourcePath - the path of the resource, for instance path/to/my-resources.properties for a properties file or my/package/MyClass.class for a class.

builder

public static QuarkusClassLoader.Builder builder(String name,
 ClassLoader parent,
 boolean parentFirst)

reset

public void reset(Map<String,byte[]> generatedResources,
 Map<String,byte[]> transformedClasses)

getResources

public Enumeration<URL> getResources(String unsanitisedName)
                              throws IOException

Overrides:

getResources in class ClassLoader

Throws:

IOException

getResources

public Enumeration<URL> getResources(String unsanitisedName,
 boolean parentAlreadyFoundResources)
                              throws IOException

Throws:

IOException

getResource

public URL getResource(String unsanitisedName)

Overrides:

getResource in class ClassLoader

getResourceAsStream

public InputStream getResourceAsStream(String unsanitisedName)

Overrides:

getResourceAsStream in class ClassLoader

findClass

protected Class<?> findClass(String moduleName,
 String name)

This method is needed to make packages work correctly on JDK9+, as it will be called to load the package-info class.

Overrides:

findClass in class ClassLoader

Parameters:

moduleName -

name -

Returns:

findResource

protected URL findResource(String name)

Overrides:

findResource in class ClassLoader

findResources

protected Enumeration<URL> findResources(String name)
                                  throws IOException

Overrides:

findResources in class ClassLoader

Throws:

IOException

loadClass

public Class<?> loadClass(String name)
                   throws ClassNotFoundException

Overrides:

loadClass in class ClassLoader

Throws:

ClassNotFoundException

loadClass

protected Class<?> loadClass(String name,
 boolean resolve)
                      throws ClassNotFoundException

Overrides:

loadClass in class ClassLoader

Throws:

ClassNotFoundException

getElementsWithResource

public List<ClassPathElement> getElementsWithResource(String name)

getElementsWithResource

public List<ClassPathElement> getElementsWithResource(String name,
 boolean localOnly)

getReloadableClassNames

public Set<String> getReloadableClassNames()

visibleDefineClass

public Class<?> visibleDefineClass(String name,
 byte[] b,
 int off,
 int len)
                            throws ClassFormatError

Throws:

ClassFormatError

addCloseTask

public void addCloseTask(Runnable task)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isClosed

public boolean isClosed()

toString

public String toString()

Overrides:

toString in class Object

parent

public ClassLoader parent()

getName

public String getName()

Overrides:

getName in class ClassLoader