com.djrapitops.plugin

Class VelocityPlugin

java.lang.Object

com.djrapitops.plugin.VelocityPlugin

All Implemented Interfaces:

APFPlugin, IPlugin

public abstract class VelocityPlugin
extends Object
implements APFPlugin

IPlugin implementation for Velocity.

This class should be extended when creating a velocity part of your plugin using this library. It provides instances for a PluginLogger, DebugLogger, ErrorHandler, Timings and RunnableFactory.

If you wish to change default debug or error handling behavior, use IPlugin.setDebugLoggers(com.djrapitops.plugin.logging.debug.DebugLogger...) IPlugin.setErrorHandlers(com.djrapitops.plugin.logging.error.ErrorHandler...)

Author:

Rsl1122

See Also:

for method overview.

Field Summary

Fields

Modifier and Type	Field and Description
protected CombineDebugLogger	debugLogger
protected DefaultErrorHandler	errorHandler
protected PluginLogger	logger
protected com.velocitypowered.api.proxy.ProxyServer	proxy
protected boolean	reloading
protected RunnableFactory	runnableFactory
protected Timings	timings

Constructor Summary

Constructors

Constructor and Description
VelocityPlugin(com.velocitypowered.api.proxy.ProxyServer proxy, org.slf4j.Logger slf4jLogger, Path dataFolderPath) Standard constructor that initializes the plugin with the default DebugLogger.
VelocityPlugin(com.velocitypowered.api.proxy.ProxyServer proxy, org.slf4j.Logger slf4jLogger, Path dataFolderPath, CombineDebugLogger debugLogger) Constructor for defining a debug logger at creation time.

Method Summary

Modifier and Type	Method and Description
File	getDataFolder()
DebugLogger	getDebugLogger()
ErrorHandler	getErrorHandler()
protected org.slf4j.Logger	getLogger() Implement this method by injecting slf4j.Logger in your plugin class.
PluginLogger	getPluginLogger()
com.velocitypowered.api.proxy.ProxyServer	getProxy() Implement this method by injecting ProxyServer in your plugin class.
RunnableFactory	getRunnableFactory()
Timings	getTimings()
String	getVersion()
boolean	isReloading()
void	onDisable()
void	onReload()
void	registerCommand(String name, CommandNode command)
void	registerListener(Object... listeners)
void	reloadPlugin(boolean full)
void	setDebugLoggers(DebugLogger... loggers)
void	setErrorHandlers(ErrorHandler... errorHandlers)
void	setReloading(boolean reloading)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.djrapitops.plugin.IPlugin

onEnable

Field Detail

proxy

protected final com.velocitypowered.api.proxy.ProxyServer proxy

logger

protected final PluginLogger logger

debugLogger

protected final CombineDebugLogger debugLogger

errorHandler

protected final DefaultErrorHandler errorHandler

timings

protected final Timings timings

runnableFactory

protected final RunnableFactory runnableFactory

reloading

protected boolean reloading

Constructor Detail

VelocityPlugin

public VelocityPlugin(com.velocitypowered.api.proxy.ProxyServer proxy,
                      org.slf4j.Logger slf4jLogger,
                      Path dataFolderPath)

Standard constructor that initializes the plugin with the default DebugLogger.

Parameters:

proxy - Injected ProxyServer.

slf4jLogger - Injected Logger.

dataFolderPath - Injected Path to the plugin data folder.

VelocityPlugin

public VelocityPlugin(com.velocitypowered.api.proxy.ProxyServer proxy,
                      org.slf4j.Logger slf4jLogger,
                      Path dataFolderPath,
                      CombineDebugLogger debugLogger)

Constructor for defining a debug logger at creation time.

Parameters:

proxy - Injected ProxyServer.

slf4jLogger - Injected Logger.

dataFolderPath - Injected Path to the plugin data folder.

debugLogger - debug logger to use.

Method Detail

getDataFolder

public File getDataFolder()

Specified by:

getDataFolder in interface IPlugin

getProxy

public com.velocitypowered.api.proxy.ProxyServer getProxy()

Implement this method by injecting ProxyServer in your plugin class.

Returns:

ProxyServer in use.

getLogger

protected org.slf4j.Logger getLogger()

Implement this method by injecting slf4j.Logger in your plugin class.

Returns:

Logger of the plugin.

onDisable

public void onDisable()

Specified by:

onDisable in interface IPlugin

onReload

public void onReload()

Specified by:

onReload in interface IPlugin

reloadPlugin

public void reloadPlugin(boolean full)

Specified by:

reloadPlugin in interface IPlugin

registerListener

public void registerListener(Object... listeners)

registerCommand

public void registerCommand(String name,
                            CommandNode command)

Specified by:

registerCommand in interface IPlugin

getVersion

public String getVersion()

Specified by:

getVersion in interface IPlugin

getDebugLogger

public DebugLogger getDebugLogger()

Specified by:

getDebugLogger in interface IPlugin

getErrorHandler

public ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface IPlugin

getTimings

public Timings getTimings()

Specified by:

getTimings in interface IPlugin

getRunnableFactory

public RunnableFactory getRunnableFactory()

Specified by:

getRunnableFactory in interface IPlugin

getPluginLogger

public PluginLogger getPluginLogger()

Specified by:

getPluginLogger in interface IPlugin

isReloading

public boolean isReloading()

Specified by:

isReloading in interface IPlugin

setReloading

public void setReloading(boolean reloading)

Specified by:

setReloading in interface APFPlugin

setDebugLoggers

public void setDebugLoggers(DebugLogger... loggers)

Specified by:

setDebugLoggers in interface IPlugin

setErrorHandlers

public void setErrorHandlers(ErrorHandler... errorHandlers)

Specified by:

setErrorHandlers in interface IPlugin