xyz.maow.jarvae

Class JarClassLoader

java.lang.Object

java.lang.ClassLoader

xyz.maow.jarvae.JarClassLoader

public class JarClassLoader
extends java.lang.ClassLoader

A custom class loader implementation that allows classes to be found and loaded based on the classes in a JarFile.

This class loader is designed to be used by programs with a module or plugin system.

A usage example would be:

 JarFile jar = new JarFile("plugin.jar");
 JarClassLoader cl = new JarClassLoader(jar);
 Class clazz = cl.loadClass("me.plugin.MainClass");
 

It is up to the one developing such a program to decide how a class name should be found.

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
JarClassLoader(java.lang.ClassLoader parent, java.util.jar.JarFile jar) Creates a new JarClassLoader with a parent class loader.
JarClassLoader(java.lang.ClassLoader parent, java.lang.String baseDir, java.util.jar.JarFile jar) Creates a new JarClassLoader with a parent class loader and base directory.
JarClassLoader(java.util.jar.JarFile jar) Creates a new JarClassLoader.
JarClassLoader(java.lang.String baseDir, java.util.jar.JarFile jar) Creates a new JarClassLoader with a base directory.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class<?>	findClass(java.lang.String name)

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findResource, findResources, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResourceAsStream, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Constructor Detail

JarClassLoader

public JarClassLoader(java.lang.ClassLoader parent,
                      java.lang.String baseDir,
                      java.util.jar.JarFile jar)

Creates a new JarClassLoader with a parent class loader and base directory.

The base directory is used as a path prefix, and is required if your class files are nested within another folder.

Parameters:

parent - the parent class loader

baseDir - base directory

jar - the jar file to read from

Throws:

java.lang.NullPointerException - if jar is null

JarClassLoader

public JarClassLoader(java.lang.ClassLoader parent,
                      java.util.jar.JarFile jar)

Creates a new JarClassLoader with a parent class loader.

Parameters:

parent - the parent class loader

jar - the jar file to read from

Throws:

java.lang.NullPointerException - if jar is null

JarClassLoader

public JarClassLoader(java.lang.String baseDir,
                      java.util.jar.JarFile jar)

Creates a new JarClassLoader with a base directory.

The base directory is used as a path prefix, and is required if your class files are nested within another folder.

Parameters:

baseDir - base directory

jar - the jar file to read from

Throws:

java.lang.NullPointerException - if jar is null

JarClassLoader

public JarClassLoader(java.util.jar.JarFile jar)

Creates a new JarClassLoader.

Parameters:

jar - the jar file to read from

Throws:

java.lang.NullPointerException - if jar is null

Method Detail

findClass

protected java.lang.Class<?> findClass(java.lang.String name)
                                throws java.lang.ClassNotFoundException

Overrides:

findClass in class java.lang.ClassLoader

Throws:

java.lang.ClassNotFoundException