me.lucko.helper.plugin

Interface HelperPlugin

All Superinterfaces:

CommandExecutor, Plugin, TabCompleter, TabExecutor, TerminableConsumer

All Known Implementing Classes:

ExtendedJavaPlugin, StandalonePlugin

public interface HelperPlugin
extends Plugin, TerminableConsumer

Method Summary

Modifier and Type	Method and Description
File	getBundledFile(String name) Gets a bundled file from the plugins resource folder.
ClassLoader	getClassloader() Gets the plugin's class loader
<T> T	getPlugin(String name, Class<T> pluginClass) Gets a plugin instance for the given plugin name
<T> T	getService(Class<T> service) Gets a service provided by the ServiceManager
boolean	isPluginPresent(String name) Gets if a given plugin is enabled.
YamlConfiguration	loadConfig(String file) Loads a config file from a file name.
ninja.leaping.configurate.ConfigurationNode	loadConfigNode(String file) Loads a config file from a file name.
<T> T	provideService(Class<T> clazz, T instance) Provides a service to the ServiceManager, bound to this plugin at ServicePriority.Normal.
<T> T	provideService(Class<T> clazz, T instance, ServicePriority priority) Provides a service to the ServiceManager, bound to this plugin
default <T extends CommandExecutor> T	registerCommand(T command, String... aliases) Registers a CommandExecutor with the server
<T extends CommandExecutor> T	registerCommand(T command, String permission, String permissionMessage, String description, String... aliases) Registers a CommandExecutor with the server
<T extends Listener> T	registerListener(T listener) Register a listener with the server.
<T> T	setupConfig(String file, T configObject) Populates a config object.

Methods inherited from interface org.bukkit.plugin.Plugin

getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getLogger, getName, getPluginLoader, getResource, getServer, isEnabled, isNaggable, onDisable, onEnable, onLoad, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Methods inherited from interface org.bukkit.command.CommandExecutor

onCommand

Methods inherited from interface me.lucko.helper.terminable.TerminableConsumer

bind, bindModule

Method Detail

registerListener

@Nonnull
<T extends Listener> T registerListener(@Nonnull
                                                 T listener)

Register a listener with the server.

Events should be used instead of this method in most cases.

Type Parameters:

T - the listener class type

Parameters:

listener - the listener to register

Returns:

the listener

registerCommand

@Nonnull
default <T extends CommandExecutor> T registerCommand(@Nonnull
                                                               T command,
                                                               @Nonnull
                                                               String... aliases)

Registers a CommandExecutor with the server

Type Parameters:

T - the command executor class type

Parameters:

command - the command instance

aliases - the command aliases

Returns:

the command executor

registerCommand

@Nonnull
<T extends CommandExecutor> T registerCommand(@Nonnull
                                                       T command,
                                                       String permission,
                                                       String permissionMessage,
                                                       String description,
                                                       @Nonnull
                                                       String... aliases)

Registers a CommandExecutor with the server

Type Parameters:

T - the command executor class type

Parameters:

command - the command instance

permission - the command permission

permissionMessage - the message sent when the sender doesn't the required permission

description - the command description

aliases - the command aliases

Returns:

the command executor

getService

@Nonnull
<T> T getService(@Nonnull
                          Class<T> service)

Gets a service provided by the ServiceManager

Type Parameters:

T - the class type

Parameters:

service - the service class

Returns:

the service

provideService

@Nonnull
<T> T provideService(@Nonnull
                              Class<T> clazz,
                              @Nonnull
                              T instance,
                              @Nonnull
                              ServicePriority priority)

Provides a service to the ServiceManager, bound to this plugin

Type Parameters:

T - the service class type

Parameters:

clazz - the service class

instance - the instance

priority - the priority to register the service at

Returns:

the instance

provideService

@Nonnull
<T> T provideService(@Nonnull
                              Class<T> clazz,
                              @Nonnull
                              T instance)

Provides a service to the ServiceManager, bound to this plugin at ServicePriority.Normal.

Type Parameters:

T - the service class type

Parameters:

clazz - the service class

instance - the instance

Returns:

the instance

isPluginPresent

boolean isPluginPresent(@Nonnull
                        String name)

Gets if a given plugin is enabled.

Parameters:

name - the name of the plugin

Returns:

if the plugin is enabled

getPlugin

@Nullable
<T> T getPlugin(@Nonnull
                          String name,
                          @Nonnull
                          Class<T> pluginClass)

Gets a plugin instance for the given plugin name

Type Parameters:

T - the main class type

Parameters:

name - the name of the plugin

pluginClass - the main plugin class

Returns:

the plugin

getBundledFile

@Nonnull
File getBundledFile(@Nonnull
                             String name)

Gets a bundled file from the plugins resource folder.

If the file is not present, a version of it it copied from the jar.

Parameters:

name - the name of the file

Returns:

the file

loadConfig

@Nonnull
YamlConfiguration loadConfig(@Nonnull
                                      String file)

Loads a config file from a file name.

Behaves in the same was as getBundledFile(String) when the file is not present.

Parameters:

file - the name of the file

Returns:

the config instance

loadConfigNode

@Nonnull
ninja.leaping.configurate.ConfigurationNode loadConfigNode(@Nonnull
                                                                    String file)

Loads a config file from a file name.

Behaves in the same was as getBundledFile(String) when the file is not present.

Parameters:

file - the name of the file

Returns:

the config instance

setupConfig

@Nonnull
<T> T setupConfig(@Nonnull
                           String file,
                           @Nonnull
                           T configObject)

Populates a config object.

Type Parameters:

T - the config object type

Parameters:

file - the name of the file

configObject - the config object

getClassloader

@Nonnull
ClassLoader getClassloader()

Gets the plugin's class loader

Returns:

the class loader