net.lenni0451.spm.utils

Class PluginUtils

java.lang.Object

net.lenni0451.spm.utils.PluginUtils

public class PluginUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PluginUtils()

Method Summary

Modifier and Type	Method and Description
boolean	disablePlugin(org.bukkit.plugin.Plugin plugin) Disable a Plugin by its instance
boolean	disablePlugin(java.lang.String name) Disable a Plugin by its name
boolean	enablePlugin(org.bukkit.plugin.Plugin plugin) Enable a Plugin by its instance
boolean	enablePlugin(java.lang.String name) Enable a Plugin by its name
java.util.List<java.lang.String>	getCommands(org.bukkit.plugin.Plugin plugin) Get a List of all commands registered by Plugins This only works if they are registered as PluginCommands Anything using events or other methods to handle commands will not work
java.util.Optional<org.bukkit.plugin.Plugin>	getPlugin(java.lang.String name) Get a Plugin instance by its name
org.bukkit.plugin.PluginDescriptionFile	getPluginDescription(java.io.File file) Get the PluginDescriptionFile of a plugin jar
java.util.Optional<java.io.File>	getPluginFile(org.bukkit.plugin.Plugin plugin) Get the File of the Plugin jar This tries calling the JavaPlugin.getFile() method first If that fails, all PluginDescriptionFiles are searched for the name of the Plugin
org.bukkit.plugin.PluginManager	getPluginManager() Get the PluginManager instance of the server
org.bukkit.plugin.Plugin[]	getPlugins() Get an array of all loaded Plugins
java.util.List<org.bukkit.plugin.Plugin>	getPluginsByLoadOrder() Get a List of all Plugins sorted by their dependencies Loading all Plugins in the correct order is important for the correct functioning of the Plugins
java.io.File	getPluginsDirectory() Get the plugins directory
java.io.File	getUpdateDirectory() Get the update directory for plugins
boolean	isPluginEnabled(java.lang.String name) Check if a Plugin is enabled by its name
boolean	isPluginLoaded(java.lang.String name) Check if a Plugin is loaded by its name
org.bukkit.plugin.Plugin	loadPlugin(org.bukkit.plugin.Plugin plugin) Load a Plugin by its instance See loadPlugin(String) for more information
org.bukkit.plugin.Plugin	loadPlugin(java.lang.String name) Load a Plugin by its name This tries to get the Plugin File by name and if not found scans all PluginDescriptionFiles for the name
void	reloadConfig(org.bukkit.plugin.Plugin plugin) Reload the config of a Plugin by its instance
void	reloadConfig(java.lang.String name) Reload the config of a Plugin by its name
org.bukkit.plugin.Plugin	reloadPlugin(org.bukkit.plugin.Plugin plugin) Reload a Plugin by its name This first unloads the Plugin and then loads it again
void	unloadPlugin(org.bukkit.plugin.Plugin plugin) Unload a Plugin by its instance This closes the URLClassLoader of the Plugin which causes the Plugin no longer being able to load new Classes
void	unloadPlugin(java.lang.String name) Unload a Plugin by its name See unloadPlugin(Plugin) for more information
boolean	updatePlugin(java.io.File pluginFile) Update a Plugin from the updates folder

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginUtils

public PluginUtils()

Method Detail

getPluginsDirectory

public java.io.File getPluginsDirectory()

Get the plugins directory

Returns:

The File

getUpdateDirectory

public java.io.File getUpdateDirectory()

Get the update directory for plugins

Returns:

The File

getPluginManager

public org.bukkit.plugin.PluginManager getPluginManager()

Get the PluginManager instance of the server

Returns:

The PluginManager instance

getPluginDescription

public org.bukkit.plugin.PluginDescriptionFile getPluginDescription(java.io.File file)
                                                             throws org.bukkit.plugin.InvalidDescriptionException

Get the PluginDescriptionFile of a plugin jar

Parameters:

file - The plugin jar

Returns:

The PluginDescriptionFile

Throws:

org.bukkit.plugin.InvalidDescriptionException - If the plugin.yml is invalid

getPlugins

public org.bukkit.plugin.Plugin[] getPlugins()

Get an array of all loaded Plugins

Returns:

All loaded Plugins

getPlugin

public java.util.Optional<org.bukkit.plugin.Plugin> getPlugin(java.lang.String name)

Get a Plugin instance by its name

Parameters:

name - The name of the Plugin

Returns:

The Plugin instance or Optional.empty() if not found

isPluginLoaded

public boolean isPluginLoaded(java.lang.String name)

Check if a Plugin is loaded by its name

Parameters:

name - The name of the Plugin

Returns:

true if the Plugin is loaded

isPluginEnabled

public boolean isPluginEnabled(java.lang.String name)

Check if a Plugin is enabled by its name

Parameters:

name - The name of the Plugin

Returns:

true if the Plugin is enabled

enablePlugin

public boolean enablePlugin(java.lang.String name)

Enable a Plugin by its name

Parameters:

name - The name of the Plugin

Returns:

true if the Plugin was enabled successfully

enablePlugin

public boolean enablePlugin(org.bukkit.plugin.Plugin plugin)

Enable a Plugin by its instance

Parameters:

plugin - The Plugin instance

Returns:

true if the Plugin was enabled successfully

disablePlugin

public boolean disablePlugin(java.lang.String name)

Disable a Plugin by its name

Parameters:

name - The name of the Plugin

Returns:

true if the Plugin was disabled successfully

disablePlugin

public boolean disablePlugin(org.bukkit.plugin.Plugin plugin)

Disable a Plugin by its instance

Parameters:

plugin - The Plugin instance

Returns:

true if the Plugin was disabled successfully

reloadConfig

public void reloadConfig(java.lang.String name)

Reload the config of a Plugin by its name

Parameters:

name - The name of the Plugin

reloadConfig

public void reloadConfig(org.bukkit.plugin.Plugin plugin)

Reload the config of a Plugin by its instance

Parameters:

plugin - The Plugin instance

reloadPlugin

public org.bukkit.plugin.Plugin reloadPlugin(org.bukkit.plugin.Plugin plugin)

Reload a Plugin by its name
This first unloads the Plugin and then loads it again

Parameters:

plugin - The Plugin instance

Returns:

The new Plugin instance

Throws:

java.lang.IllegalStateException - If anything goes wrong

loadPlugin

public org.bukkit.plugin.Plugin loadPlugin(org.bukkit.plugin.Plugin plugin)

Load a Plugin by its instance
See loadPlugin(String) for more information

Parameters:

plugin - The Plugin instance

Returns:

The new Plugin instance

Throws:

java.lang.IllegalStateException - If anything goes wrong

loadPlugin

public org.bukkit.plugin.Plugin loadPlugin(java.lang.String name)

Load a Plugin by its name
This tries to get the Plugin File by name and if not found scans all PluginDescriptionFiles for the name

Parameters:

name - The name of the Plugin

Returns:

The new Plugin instance

Throws:

java.lang.IllegalStateException - If anything goes wrong

unloadPlugin

public void unloadPlugin(java.lang.String name)

Unload a Plugin by its name
See unloadPlugin(Plugin) for more information

Parameters:

name - The name of the Plugin

Throws:

java.lang.IllegalStateException - If anything goes wrong

unloadPlugin

public void unloadPlugin(org.bukkit.plugin.Plugin plugin)

Unload a Plugin by its instance
This closes the URLClassLoader of the Plugin which causes the Plugin no longer being able to load new Classes

Parameters:

plugin - The Plugin instance

Throws:

java.lang.IllegalStateException - If anything goes wrong

getPluginsByLoadOrder

public java.util.List<org.bukkit.plugin.Plugin> getPluginsByLoadOrder()

Get a List of all Plugins sorted by their dependencies
Loading all Plugins in the correct order is important for the correct functioning of the Plugins

Returns:

The List

getCommands

public java.util.List<java.lang.String> getCommands(org.bukkit.plugin.Plugin plugin)

Get a List of all commands registered by Plugins
This only works if they are registered as PluginCommands
Anything using events or other methods to handle commands will not work

Parameters:

plugin - The instance of the Plugin

Returns:

The List

getPluginFile

public java.util.Optional<java.io.File> getPluginFile(org.bukkit.plugin.Plugin plugin)

Get the File of the Plugin jar
This tries calling the JavaPlugin.getFile() method first
If that fails, all PluginDescriptionFiles are searched for the name of the Plugin

Parameters:

plugin - The instance of the Plugin

Returns:

The File of the Plugin jar or Optional.empty() if not found

updatePlugin

public boolean updatePlugin(java.io.File pluginFile)

Update a Plugin from the updates folder

Parameters:

pluginFile - The File of the Plugin

Returns:

true if the update was successful