Package org.bukkit.plugin.java

Class PluginClassLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

org.bukkit.plugin.java.PluginClassLoader

All Implemented Interfaces:

ConfiguredPluginClassLoader, Closeable, AutoCloseable

@Internal
public final class PluginClassLoader
extends URLClassLoader
implements ConfiguredPluginClassLoader

A ClassLoader for plugins, to allow shared classes across multiple plugins

Field Summary

Fields

Modifier and Type	Field	Description
DependencyContext	dependencyContext

Constructor Summary

Constructors

Constructor	Description
PluginClassLoader(@Nullable ClassLoader parent, @NotNull PluginDescriptionFile description, @NotNull File dataFolder, @NotNull File file, @Nullable ClassLoader libraryLoader, JarFile jarFile, DependencyContext dependencyContext)

Method Summary

Modifier and Type	Method	Description
void	close()
protected Class<?>	findClass(String name)
PluginMeta	getConfiguration()	Provides the configuration of the plugin that this plugin classloader provides type access to.
PluginClassLoaderGroup	getGroup()	Get the plugin classloader group that is used by the underlying classloader
JavaPlugin	getPlugin()	Gets the plugin held by this class loader.
URL	getResource(String name)
Enumeration<URL>	getResources(String name)
void	init(JavaPlugin plugin)	Initializes both this configured plugin class loader and the java plugin passed to link to each other.
void	initialize(@NotNull JavaPlugin javaPlugin)
Class<?>	loadClass(@NotNull String name, boolean resolve, boolean checkGlobal, boolean checkLibraries)	Attempts to load a class from this plugin class loader using the passed fully qualified name.
protected Class<?>	loadClass(String name, boolean resolve)
String	toString()

Methods inherited from class java.net.URLClassLoader

addURL, definePackage, findResource, findResources, getPermissions, getResourceAsStream, getURLs, newInstance, newInstance

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getName, getPackage, getPackages, getParent, getPlatformClassLoader, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, 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

dependencyContext

public DependencyContext dependencyContext

Constructor Details

PluginClassLoader

@Internal
public PluginClassLoader(@Nullable
 @Nullable ClassLoader parent,
 @NotNull
 @NotNull PluginDescriptionFile description,
 @NotNull
 @NotNull File dataFolder,
 @NotNull
 @NotNull File file,
 @Nullable
 @Nullable ClassLoader libraryLoader,
 JarFile jarFile,
 DependencyContext dependencyContext)
                  throws IOException,
InvalidPluginException,
MalformedURLException

Throws:

IOException

InvalidPluginException

MalformedURLException

Method Details

getResource

public URL getResource(String name)

Overrides:

getResource in class ClassLoader

getResources

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

Overrides:

getResources in class ClassLoader

Throws:

IOException

loadClass

public Class<?> loadClass(@NotNull
 @NotNull String name,
 boolean resolve,
 boolean checkGlobal,
 boolean checkLibraries)
                   throws ClassNotFoundException

Description copied from interface: ConfiguredPluginClassLoader

Attempts to load a class from this plugin class loader using the passed fully qualified name. This lookup logic can be configured through the following parameters to define how wide or how narrow the class lookup should be.

Specified by:

loadClass in interface ConfiguredPluginClassLoader

Parameters:

name - the fully qualified name of the class to load

resolve - whether the class should be resolved if needed or not

checkGlobal - whether this lookup should check transitive dependencies, including either the legacy spigot global class loader or the paper PluginClassLoaderGroup

checkLibraries - whether the defined libraries should be checked for the class or not

Returns:

the class found at the fully qualified class name passed under the passed restrictions

Throws:

ClassNotFoundException - if the class could not be found considering the passed restrictions

See Also:

• ClassLoader.loadClass(String)
• Class.forName(String, boolean, ClassLoader)

getConfiguration

public PluginMeta getConfiguration()

Description copied from interface: ConfiguredPluginClassLoader

Provides the configuration of the plugin that this plugin classloader provides type access to.

Specified by:

getConfiguration in interface ConfiguredPluginClassLoader

Returns:

the plugin meta instance, holding all meta information about the plugin instance.

init

public void init(JavaPlugin plugin)

Description copied from interface: ConfiguredPluginClassLoader

Initializes both this configured plugin class loader and the java plugin passed to link to each other. This logic is to be called exactly once when the initial setup between the class loader and the instantiated JavaPlugin is loaded.

Specified by:

init in interface ConfiguredPluginClassLoader

Parameters:

plugin - the JavaPlugin that should be interlinked with this class loader.

getPlugin

public JavaPlugin getPlugin()

Description copied from interface: ConfiguredPluginClassLoader

Gets the plugin held by this class loader.

Specified by:

getPlugin in interface ConfiguredPluginClassLoader

Returns:

the plugin or null if it doesn't exist yet

loadClass

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

Overrides:

loadClass in class ClassLoader

Throws:

ClassNotFoundException

findClass

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

Overrides:

findClass in class URLClassLoader

Throws:

ClassNotFoundException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class URLClassLoader

Throws:

IOException

initialize

public void initialize(@NotNull
 @NotNull JavaPlugin javaPlugin)

toString

public String toString()

Overrides:

toString in class Object

getGroup

@Nullable
public PluginClassLoaderGroup getGroup()

Description copied from interface: ConfiguredPluginClassLoader

Get the plugin classloader group that is used by the underlying classloader

Specified by:

getGroup in interface ConfiguredPluginClassLoader

Returns:

classloader