me.lucko.helper.plugin

Class ExtendedJavaPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

me.lucko.helper.plugin.ExtendedJavaPlugin

All Implemented Interfaces:

HelperPlugin, CompositeTerminableConsumer, TerminableConsumer, CommandExecutor, TabCompleter, TabExecutor, Plugin

Direct Known Subclasses:

DummyHelperPlugin

public class ExtendedJavaPlugin
extends JavaPlugin
implements HelperPlugin

An "extended" JavaPlugin class.

Constructor Summary

Constructors

Constructor and Description
ExtendedJavaPlugin()

Method Summary

Modifier and Type	Method and Description
<T extends Terminable> T	bind(T terminable) Binds with the given terminable.
<T extends CompositeTerminable> T	bindComposite(T terminable) Binds a composite terminable to this consumer
<T extends Runnable> T	bindRunnable(T runnable) Binds with the given runnable.
protected void	disable()
protected void	enable()
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
protected void	load()
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.
void	onDisable()
void	onEnable()
void	onLoad()
<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
<T extends CommandExecutor> T	registerCommand(T command, String... aliases) Registers a CommandExecutor with the server
<T extends Listener> T	registerListener(T listener) Register a listener with the server.

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, 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 org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.plugin.Plugin

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

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Methods inherited from interface org.bukkit.command.CommandExecutor

onCommand

Constructor Detail

ExtendedJavaPlugin

public ExtendedJavaPlugin()

Method Detail

load

protected void load()

enable

protected void enable()

disable

protected void disable()

onLoad

public final void onLoad()

Specified by:

onLoad in interface Plugin

Overrides:

onLoad in class JavaPlugin

onEnable

public final void onEnable()

Specified by:

onEnable in interface Plugin

Overrides:

onEnable in class JavaPlugin

onDisable

public final void onDisable()

Specified by:

onDisable in interface Plugin

Overrides:

onDisable in class JavaPlugin

bind

@Nonnull
public <T extends Terminable> T bind(@Nonnull
                                               T terminable)

Description copied from interface: TerminableConsumer

Binds with the given terminable.

Specified by:

bind in interface TerminableConsumer

Type Parameters:

T - the terminable type

Parameters:

terminable - the terminable to bind with

Returns:

the same terminable

bindRunnable

@Nonnull
public <T extends Runnable> T bindRunnable(@Nonnull
                                                     T runnable)

Description copied from interface: TerminableConsumer

Binds with the given runnable.

Specified by:

bindRunnable in interface TerminableConsumer

Type Parameters:

T - the terminable type

Parameters:

runnable - the runnable to bind with

Returns:

the same terminable

bindComposite

@Nonnull
public <T extends CompositeTerminable> T bindComposite(@Nonnull
                                                                 T terminable)

Description copied from interface: CompositeTerminableConsumer

Binds a composite terminable to this consumer

Specified by:

bindComposite in interface CompositeTerminableConsumer

Type Parameters:

T - the terminable class type

Parameters:

terminable - the terminable to bind

Returns:

the terminable instance

registerListener

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

Description copied from interface: HelperPlugin

Register a listener with the server.

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

Specified by:

registerListener in interface HelperPlugin

Type Parameters:

T - the listener class type

Parameters:

listener - the listener to register

Returns:

the listener

registerCommand

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

Description copied from interface: HelperPlugin

Registers a CommandExecutor with the server

Specified by:

registerCommand in interface HelperPlugin

Type Parameters:

T - the command executor class type

Parameters:

command - the command instance

aliases - the command aliases

Returns:

the command executor

getService

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

Description copied from interface: HelperPlugin

Gets a service provided by the ServiceManager

Specified by:

getService in interface HelperPlugin

Type Parameters:

T - the class type

Parameters:

service - the service class

Returns:

the service

provideService

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

Description copied from interface: HelperPlugin

Provides a service to the ServiceManager, bound to this plugin

Specified by:

provideService in interface HelperPlugin

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
public <T> T provideService(@Nonnull
                                      Class<T> clazz,
                                      @Nonnull
                                      T instance)

Description copied from interface: HelperPlugin

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

Specified by:

provideService in interface HelperPlugin

Type Parameters:

T - the service class type

Parameters:

clazz - the service class

instance - the instance

Returns:

the instance

getPlugin

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

Description copied from interface: HelperPlugin

Gets a plugin instance for the given plugin name

Specified by:

getPlugin in interface HelperPlugin

Type Parameters:

T - the main class type

Parameters:

name - the name of the plugin

pluginClass - the main plugin class

Returns:

the plugin

getBundledFile

@Nonnull
public File getBundledFile(@Nonnull
                                     String name)

Description copied from interface: HelperPlugin

Gets a bundled file from the plugins resource folder.

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

Specified by:

getBundledFile in interface HelperPlugin

Parameters:

name - the name of the file

Returns:

the file

loadConfig

@Nonnull
public YamlConfiguration loadConfig(@Nonnull
                                              String file)

Description copied from interface: HelperPlugin

Loads a config file from a file name.

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

Specified by:

loadConfig in interface HelperPlugin

Parameters:

file - the name of the file

Returns:

the config instance

loadConfigNode

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

Description copied from interface: HelperPlugin

Loads a config file from a file name.

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

Specified by:

loadConfigNode in interface HelperPlugin

Parameters:

file - the name of the file

Returns:

the config instance

getClassloader

public ClassLoader getClassloader()

Description copied from interface: HelperPlugin

Gets the plugin's class loader

Specified by:

getClassloader in interface HelperPlugin

Returns:

the class loader