Package ovh.mythmc.gestalt.loader

Class PaperGestaltLoader

java.lang.Object

ovh.mythmc.gestalt.loader.GestaltLoader

ovh.mythmc.gestalt.loader.PaperGestaltLoader

public class PaperGestaltLoader
extends GestaltLoader

A GestaltLoader implementation for the Paper platform.

In addition to loading and enabling the Gestalt plugin JAR, this loader merges the Gestalt plugin's class loader into the initializer plugin's class loader group using PaperPluginClassLoaderUtil.mergeClassLoaders(Plugin, Plugin), allowing the initializer to access Gestalt's classes directly.

Use builder() to construct an instance:

 PaperGestaltLoader loader = PaperGestaltLoader.builder()
     .initializer(this)
     .build();
 loader.initialize();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaperGestaltLoader.PaperGestaltLoaderBuilder	Builder for PaperGestaltLoader.

Method Summary

Modifier and Type	Method	Description
static PaperGestaltLoader.PaperGestaltLoaderBuilder	builder()	Returns a new PaperGestaltLoader.PaperGestaltLoaderBuilder.
Path	getDataDirectory()	Returns the root data directory of the plugin.
org.bukkit.plugin.Plugin	getInitializer()	Returns the plugin that initiated the Gestalt load.
GestaltLoggerWrapper	getLogger()	Returns the logger wrapper used to emit status messages during loading.
protected boolean	isAvailable()	Returns whether Gestalt is already available and loaded on this platform.
protected void	load()	Performs the platform-specific routine to load the Gestalt JAR into the server.

Methods inherited from class ovh.mythmc.gestalt.loader.GestaltLoader

getGestaltPath, getJarPath, initialize, terminate

Methods inherited from class java.lang.Object

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

Method Details

getInitializer

public org.bukkit.plugin.Plugin getInitializer()

Returns the plugin that initiated the Gestalt load. Used for class loader merging.

Returns:

the initializer plugin

getDataDirectory

public Path getDataDirectory()

Description copied from class: GestaltLoader

Returns the root data directory of the plugin. The Gestalt JAR will be placed at <dataDirectory>/libs/gestalt.jar.

Specified by:

getDataDirectory in class GestaltLoader

Returns:

the plugin data directory

getLogger

public GestaltLoggerWrapper getLogger()

Description copied from class: GestaltLoader

Returns the logger wrapper used to emit status messages during loading.

Specified by:

getLogger in class GestaltLoader

Returns:

the logger wrapper

load

protected void load()

Description copied from class: GestaltLoader

Performs the platform-specific routine to load the Gestalt JAR into the server. Called by GestaltLoader.initialize() after the JAR has been verified to exist on disk.

Specified by:

load in class GestaltLoader

isAvailable

protected boolean isAvailable()

Description copied from class: GestaltLoader

Returns whether Gestalt is already available and loaded on this platform.

If true, GestaltLoader.initialize() will return early without downloading or loading.

Specified by:

isAvailable in class GestaltLoader

Returns:

true if Gestalt is already loaded

builder

public static PaperGestaltLoader.PaperGestaltLoaderBuilder builder()

Returns a new PaperGestaltLoader.PaperGestaltLoaderBuilder.

Returns:

a new builder