top.focess.qq.api.plugin

类 Plugin

java.lang.Object

top.focess.qq.api.plugin.Plugin

直接已知子类:

LazyPlugin, Main.MainPlugin

public abstract class Plugin
extends Object

Represent a Plugin class that can be load, enable and disable. Also, provide plenty of API for the plugin to get better with this framework. You should declare PluginType to this class.

构造器概要

构造器

限定符	构造器和说明
protected	Plugin() Provide a constructor to help PluginType design.
	Plugin(String name, String author, Version version) Initialize a Plugin instance by its name.

方法概要

限定符和类型	方法和说明
abstract void	disable() Used to save some data of the plugin
abstract void	enable() Used to initialize the plugin
boolean	equals(Object o)
String	getAuthor()
@NotNull YamlConfiguration	getConfig()
@NotNull File	getConfigFile()
DefaultConfig	getDefaultConfig()
@NotNull File	getDefaultFolder()
LangConfig	getLangConfig()
@NotNull String	getName()
static Plugin	getPlugin(Class<? extends Plugin> plugin) Get Plugin instance by the class instance
static Plugin	getPlugin(String name) Get Plugin instance by the name
PluginDescription	getPluginDescription()
Version	getVersion()
int	hashCode()
InputStream	loadResource(String path)
void	registerBuffer(DataConverter<?> dataConverter, DataCollection.BufferGetter bufferGetter) Register the getter of the buffer
void	registerCommand(Command command) Register the command
void	registerListener(Listener listener) Register the listener into the Event chain
static @Nullable Plugin	thisPlugin()

从类继承的方法 java.lang.Object

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

构造器详细资料

Plugin

public Plugin(String name,
              String author,
              Version version)

Initialize a Plugin instance by its name. Never instance it! It will be instanced when bot bootstraps automatically.

参数:

name - the plugin name

author - the plugin author

version - the plugin version

抛出:

PluginLoaderException - if the classloader of the plugin is not PluginClassLoader

Plugin

protected Plugin()

Provide a constructor to help PluginType design. Never instance it! It will be instanced when bot bootstraps automatically.

方法详细资料

getPlugin

public static Plugin getPlugin(Class<? extends Plugin> plugin)

Get Plugin instance by the class instance

参数:

plugin - the class instance of the plugin

返回:

the plugin instance

另请参阅:

PluginClassLoader.getPlugin(Class)

getPlugin

public static Plugin getPlugin(String name)

Get Plugin instance by the name

参数:

name - the name of the plugin

返回:

the plugin instance

另请参阅:

PluginClassLoader.getPlugin(String)

thisPlugin

@Nullable
public static @Nullable Plugin thisPlugin()

getName

@NotNull
public @NotNull String getName()

enable

public abstract void enable()

Used to initialize the plugin

disable

public abstract void disable()

Used to save some data of the plugin

getDefaultFolder

@NotNull
public @NotNull File getDefaultFolder()

getConfigFile

@NotNull
public @NotNull File getConfigFile()

getConfig

@NotNull
public @NotNull YamlConfiguration getConfig()

equals

public boolean equals(Object o)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

registerListener

public void registerListener(Listener listener)

Register the listener into the Event chain

参数:

listener - the listener need to be registered

registerCommand

public void registerCommand(Command command)

Register the command

参数:

command - the command need to be registered

registerBuffer

public void registerBuffer(DataConverter<?> dataConverter,
                           DataCollection.BufferGetter bufferGetter)

Register the getter of the buffer

参数:

dataConverter - the buffer data converter

bufferGetter - the getter of the buffer

getAuthor

public String getAuthor()

getVersion

public Version getVersion()

getLangConfig

public LangConfig getLangConfig()

getDefaultConfig

public DefaultConfig getDefaultConfig()

getPluginDescription

public PluginDescription getPluginDescription()

loadResource

public InputStream loadResource(String path)