net.tridentsdk.plugin

Class Plugin

java.lang.Object

net.tridentsdk.plugin.Plugin

@NotThreadSafe
public class Plugin
extends Object

Must be extended by a non-inner class to represent a plugin's main class

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Field Summary

Fields

Modifier and Type	Field and Description
PluginLoader	classLoader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Plugin()

Method Summary

Modifier and Type	Method and Description
<T extends Command> T	commandBy(Class<T> c) Obtains the command instance with the class specified
File	configDirectory() The plugin directory
Config	defaultConfig() The default configuration for this plugin, which may or may not exist physically
PluginDesc	description() Obtains the annotation given by this plugin
void	disable() Called by the handler to indicate the disabling of this plugin
void	enable() Called by the handler to indicate the enabling of this plugin
boolean	equals(Object other)
int	hashCode()
void	init(File pluginFile, PluginDesc description, PluginLoader loader)
static Plugin	instance() Obtains the instance of the plugin which the caller class is in
static <T extends Plugin> T	instance(Class<T> c) Obtains the instance of the plugin which has the specified class
<T extends Listener> T	listenerBy(Class<T> c) Obtains the listener instance with the class specified
void	load() Called by the handler to indicate the plugin has been constructed
org.slf4j.Logger	logger() Gets the logger for this plugin
File	pluginFile() Obtains the file which this plugin was loaded from
void	saveDefaultConfig() Saves the configuration inside the jar to the plugin directory
void	saveResource(String name, boolean replace) Saves a resource inside the jar to the plugin directory

Methods inherited from class java.lang.Object

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

Field Detail

classLoader

public PluginLoader classLoader

Constructor Detail

Plugin

protected Plugin()

Method Detail

init

public void init(File pluginFile,
                 PluginDesc description,
                 PluginLoader loader)

instance

@Nullable
public static Plugin instance()

Obtains the instance of the plugin which the caller class is in

Returns null if the plugin has not been loaded yet, or if the class is not a plugin loaded on the server.

Returns:

the instance of the plugin

instance

@Nullable
public static <T extends Plugin> T instance(Class<T> c)

Obtains the instance of the plugin which has the specified class

Returns null if the plugin has not been loaded yet, or if the class is not a plugin loaded on the server.

Parameters:

c - the main class of the plugin to obtain the instance of

Returns:

the instance of the plugin with the specified main class

load

public void load()

Called by the handler to indicate the plugin has been constructed

enable

public void enable()

Called by the handler to indicate the enabling of this plugin

disable

public void disable()

Called by the handler to indicate the disabling of this plugin

listenerBy

public <T extends Listener> T listenerBy(Class<T> c)

Obtains the listener instance with the class specified

Parameters:

c - the class to find the listener instance by

Returns:

the listener instance registered to the server

commandBy

public <T extends Command> T commandBy(Class<T> c)

Obtains the command instance with the class specified

Parameters:

c - the class to find the command instance by

Returns:

the command instance registered to the server

logger

public org.slf4j.Logger logger()

Gets the logger for this plugin

Returns:

the logger

saveDefaultConfig

public void saveDefaultConfig()

Saves the configuration inside the jar to the plugin directory

If the configuration is already saved, this does not overwrite it.

saveResource

public void saveResource(String name,
                         boolean replace)

Saves a resource inside the jar to the plugin directory

Parameters:

name - the filename of the directory

replace - whether or not replace the old resource, if it exists

pluginFile

public final File pluginFile()

Obtains the file which this plugin was loaded from

Returns:

the file which the plugin is loaded from

defaultConfig

public Config defaultConfig()

The default configuration for this plugin, which may or may not exist physically

Returns:

the default configuration given to this plugin

configDirectory

public File configDirectory()

The plugin directory

The returned file includes the trailing file separator

Returns:

the plugin directory where resources like the default config are saved

description

@Nonnull
public final PluginDesc description()

Obtains the annotation given by this plugin

Returns:

the plugin descriptor for this plugin

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object