KSLCore/ksl.utilities.io/DynamicJarClassLoader

DynamicJarClassLoader

class DynamicJarClassLoader(val jarPaths: List<Path>) : AutoCloseable(source)

Utility for dynamically loading and instantiating classes from JAR files. The parent loader for the underlying loader will be the class loader that loaded this class. Class loading does not occur until the first call to load a class.

If a JAR file does not exist on one of the paths then an IllegalArgumentException will occur. An IOException will occur if a referenced file is not a valid JAR file.

This class should be referenced with the "use" functionality of Kotlin to ensure that the underlying loader mechanism is closed, or the close() function should be used.

Parameters

jarPaths

a list of paths that reference valid JAR files. The list must not be empty.

Constructors

DynamicJarClassLoader

constructor(jarPaths: List<Path>)

constructor(jarPath: Path)

Constructor for a single JAR file

constructor(jarPath: String)

Constructor for a single JAR file

constructor(vararg jarPaths: Path)

Constructor for multiple JAR files using vararg

constructor(vararg jarPaths: String)

Constructor for multiple JAR files using vararg

Types

Companion

object Companion

Properties

classNames

val classNames: Set<String>

The class names found within the JAR files. These names are determined directly from the JAR files. No loading of classes occurs to determine the names.

jarPaths

val jarPaths: List<Path>

urlList

val urlList: List<URL>

The list of URL representations for the JAR files

Functions

open override fun close()

Close the class loader

declaredPublicNonStaticFunction

fun declaredPublicNonStaticFunction(loadedClass: Class<*>, functionName: String): KFunction<*>?

fun declaredPublicNonStaticFunction(className: String, functionName: String): KFunction<*>?

Retrieves the public non-static (instance) function of the supplied class name based on the supplied function name.

declaredPublicNonStaticFunctions

fun declaredPublicNonStaticFunctions(loadedClass: Class<*>): List<KFunction<*>>

fun declaredPublicNonStaticFunctions(className: String): List<KFunction<*>>

Retrieves the public non-static (instance) functions of the supplied class.

declaredPublicStaticFunction

fun declaredPublicStaticFunction(loadedClass: Class<*>, functionName: String): KFunction<*>?

fun declaredPublicStaticFunction(className: String, functionName: String): KFunction<*>?

Retrieves the public static function of the supplied class name based on the supplied function name.

declaredPublicStaticFunctions

fun declaredPublicStaticFunctions(loadedClass: Class<*>): List<KFunction<*>>

fun declaredPublicStaticFunctions(className: String): List<KFunction<*>>

Retrieves the public static functions of the supplied class name.

findSubClasses

fun findSubClasses(superClass: Class<*>): Map<String, Class<*>>

getLoadedJarPaths

fun getLoadedJarPaths(): List<String>

Get the list of loaded JAR paths as a list of strings

loadClass

fun loadClass(className: String): Class<*>

Load a class by its fully qualified name. The name must be a valid class name within the supporting JAR files.

noArgumentConstructor

fun noArgumentConstructor(loadedClass: Class<*>): KFunction<*>?

Retrieves the no argument constructor of the supplied class or null if one does not exist or is inaccessible.

fun noArgumentConstructor(className: String): KFunction<*>?

Retrieves the no argument constructor of the supplied class name or null if one does not exist or is inaccessible.

noArgumentInstance

fun noArgumentInstance(loadedClass: Class<*>): Any?

Creates an instance of the class via its no argument constructor.

fun noArgumentInstance(className: String): Any?

Creates an instance of the class using its no argument constructor.

publicConstructors

fun publicConstructors(loadedClass: Class<*>): List<KFunction<*>>

Retrieves the public constructors of the supplied java class

fun publicConstructors(className: String): List<KFunction<*>>

Retrieves the public constructors of the supplied class name.

singletonObjectReference

fun singletonObjectReference(loadedClass: Class<*>): Any?

fun singletonObjectReference(singletonName: String): Any?

A Kotlin object declaration defines a (static) singleton object within the underlying synthetic class defined with a class name the same as the name of the object. This function returns the associated object reference as an Any reference or null.

toString

open override fun toString(): String