Package us.talabrek.ultimateskyblock.hook

Class PluginHook

java.lang.Object

us.talabrek.ultimateskyblock.hook.PluginHook

Direct Known Subclasses:

EconomyHook, MultiverseHook, PermissionsHook

public abstract class PluginHook
extends Object

Constructor Summary

Constructors

Constructor	Description
PluginHook(@NotNull uSkyBlock plugin, @NotNull String hookName, @NotNull String implementing)	PluginHook constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getHookName()	Gets the configured name of this hook.
@NotNull String	getImplementing()	Gets the name of the plugin that this hook implements.
void	onHook()	Called when the hook is enabled.
void	onUnhook()	Called when the hook is disabled.

Methods inherited from class java.lang.Object

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

Constructor Details

PluginHook

public PluginHook(@NotNull
 @NotNull uSkyBlock plugin,
 @NotNull
 @NotNull String hookName,
 @NotNull
 @NotNull String implementing)

PluginHook constructor.

Parameters:

plugin - uSkyBlock instance

hookName - The name of this plugin hook.

implementing - The name of the actual plugin that this hook will implement.

Method Details

onHook

public void onHook()
            throws HookFailedException

Called when the hook is enabled. Throws HookFailedException if the hooking fails.

Throws:

HookFailedException - if hooking fails.

onUnhook

public void onUnhook()
              throws HookFailedException

Called when the hook is disabled. Throws HookFailedException if the unhooking fails.

Throws:

HookFailedException - if unhooking fails.

getHookName

@NotNull
public @NotNull String getHookName()

Gets the configured name of this hook.

Returns:

Hook name

getImplementing

@NotNull
public @NotNull String getImplementing()

Gets the name of the plugin that this hook implements.

Returns:

Name of the plugin that this hook implements.