Class ScalaLoader

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

xyz.janboerman.scalaloader.ScalaLoader

All Implemented Interfaces:

CommandExecutor, TabCompleter, TabExecutor, Plugin, IScalaLoader

public final class ScalaLoader
extends JavaPlugin
implements IScalaLoader

The ScalaLoader plugin's main class! ScalaLoader enables you to write plugins in Scala. Just depend on ScalaLoader, extend ScalaPlugin, and ScalaLoader will provide the Scala runtime classes!

If you want to explicitly get the instance of the ScalaLoader plugin, use IScalaLoader.getInstance() instead. The implementation of ScalaLoader returned by this method depends on whether ScalaLoader is loaded as Paper Plugin or not.

Author:

Jannyboy11

Note:

undocumented methods are unintended for use outside of this plugin.

Constructor Summary

Constructors

Constructor	Description
ScalaLoader()

Method Summary

Modifier and Type	Method	Description
DebugSettings	getDebugSettings()	Internal use only
EventBus	getEventBus()	Get the EventBus used for registering and calling Events.
Pattern[]	getJavaPluginLoaderPatterns()
Collection<ScalaPlugin>	getScalaPlugins()	Get the loaded ScalaPlugins.
File	getScalaPluginsFolder()	Get the folder from which ScalaPlugins are loaded.
boolean	isPaperPlugin()	Get whether ScalaLoader is a Paper Plugin
ScalaLibraryClassLoader	loadOrGetScalaVersion(PluginScalaVersion scalaVersion)	Get a (fresh or cached) ScalaLibraryClassLoader that loads standard library classes from a specific Scala version.
void	onDisable()
void	onEnable()
void	onLoad()

Methods inherited from class JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class PluginBase

equals, getName, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IScalaLoader

runInMainThread, saveScalaVersionsToConfig

Modifier and Type	Method	Description
default void	runInMainThread(Runnable runnable)	Deprecated. This method is only used by deprecated methods, and thus is no longer needed.
default boolean	saveScalaVersionsToConfig(PluginScalaVersion... versions)	Add new versions of Scala to ScalaLoader's config.

Constructor Details

ScalaLoader

public ScalaLoader()

Method Details

isPaperPlugin

public boolean isPaperPlugin()

Description copied from interface: IScalaLoader

Get whether ScalaLoader is a Paper Plugin

Specified by:

isPaperPlugin in interface IScalaLoader

Returns:

true if ScalaLoader is a Paper Plugin, false if it is a regular Bukkit plugin.

See Also:

• Paper Plugins

getDebugSettings

public DebugSettings getDebugSettings()

Description copied from interface: IScalaLoader

Internal use only

Specified by:

getDebugSettings in interface IScalaLoader

getScalaPluginsFolder

public File getScalaPluginsFolder()

Description copied from interface: IScalaLoader

Get the folder from which ScalaPlugins are loaded. By default this is server_root/plugins/ScalaLoader/scalaplugins

Specified by:

getScalaPluginsFolder in interface IScalaLoader

Returns:

the folder from which ScalaPlugins are loaded

getScalaPlugins

public Collection<ScalaPlugin> getScalaPlugins()

Description copied from interface: IScalaLoader

Get the loaded ScalaPlugins.

Specified by:

getScalaPlugins in interface IScalaLoader

Returns:

the loaded ScalaPlugins.

getEventBus

public EventBus getEventBus()

Description copied from interface: IScalaLoader

Get the EventBus used for registering and calling Events.

Specified by:

getEventBus in interface IScalaLoader

Returns:

the event bus

getJavaPluginLoaderPatterns

public Pattern[] getJavaPluginLoaderPatterns()

onLoad

public void onLoad()

Specified by:

onLoad in interface Plugin

Overrides:

onLoad in class JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface Plugin

Overrides:

onEnable in class JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface Plugin

Overrides:

onDisable in class JavaPlugin

loadOrGetScalaVersion

public ScalaLibraryClassLoader loadOrGetScalaVersion(PluginScalaVersion scalaVersion)
                                              throws ScalaPluginLoaderException

Get a (fresh or cached) ScalaLibraryClassLoader that loads standard library classes from a specific Scala version. The classloader can either load classes from over the network directly, or use downloaded library archives (jar files).

Parameters:

scalaVersion - the scala version

Returns:

the class loader

Throws:

ScalaPluginLoaderException - if a url is malformed.