io.github.lukehutch.fastclasspathscanner.classloaderhandler

Interface ClassLoaderHandler

All Known Implementing Classes:

EquinoxClassLoaderHandler, JBossClassLoaderHandler, URLClassLoaderHandler, WeblogicClassLoaderHandler

public interface ClassLoaderHandler

A ClassLoader handler. Custom ClassLoaderHandlers can be registered by listing their fully-qualified class name in the file: META-INF/services/io.github.lukehutch.fastclasspathscanner.scanner.classloaderhandler.ClassLoaderHandler However, if you do create a custom ClassLoaderHandler, please consider submitting a patch upstream for incorporation into FastClasspathScanner.

Method Summary

Modifier and Type

Method and Description

boolean

handle(ClassLoader classloader, ClasspathFinder classpathFinder, LogNode log) Determine if a given ClassLoader can be handled (meaning that its classpath elements can be extracted from it), and if it can, extract the classpath elements from the ClassLoader and register them with the ClasspathFinder using classpathFinder.addClasspathElement(pathElement) or classpathFinder.addClasspathElements(path).

Method Detail

handle

boolean handle(ClassLoader classloader,
               ClasspathFinder classpathFinder,
               LogNode log)
        throws Exception

Determine if a given ClassLoader can be handled (meaning that its classpath elements can be extracted from it), and if it can, extract the classpath elements from the ClassLoader and register them with the ClasspathFinder using classpathFinder.addClasspathElement(pathElement) or classpathFinder.addClasspathElements(path).

Parameters:

classloader - The ClassLoader class to attempt to handle. If you can't directly use instanceof (because you are using introspection so that your ClassLoaderHandler implementation can be added to the upstream FastClasspathScanner project), you should iterate through the ClassLoader's superclass lineage to ensure subclasses of the target ClassLoader are correctly detected.

classpathFinder - The ClasspathFinder to register any discovered classpath elements with.

log - A logger instance -- write debug information using log.log("message"), then switch on verbose mode to view it.

Returns:

true if the passed ClassLoader was handled by this ClassLoaderHandler, else false.

Throws:

Exception