main.java.com.djrapitops.plan

Class Plan

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.djrapitops.plugin.BukkitPlugin<Plan>

main.java.com.djrapitops.plan.Plan

All Implemented Interfaces:

com.djrapitops.plugin.IPlugin, IPlan, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class Plan
extends com.djrapitops.plugin.BukkitPlugin<Plan>
implements IPlan

Main class for Bukkit that manages the plugin.

Everything can be accessed through this class. Use Plan.getInstance() to get the initialised instance of Plan.

Since:

1.0.0

Author:

Rsl1122

Constructor Summary

Constructors

Constructor and Description
Plan()

Method Summary

Modifier and Type	Method and Description
void	addToProcessQueue(Processor... processors)
int	getBootAnalysisTaskID() Used to get the ID of the BootAnalysisTask, so that it can be disabled.
Set<Database>	getDatabases() Used to get all possible database objects.
DataCache	getDataCache() Used to access Cache.
Database	getDB() Used to access active Database.
HookHandler	getHookHandler() Used to access HookHandler.
InformationManager	getInfoManager()
static Plan	getInstance() Used to get the plugin-instance singleton.
static API	getPlanAPI() Used to get the PlanAPI.
ProcessingQueue	getProcessingQueue()
BukkitServerInfoManager	getServerInfoManager() Used to get the object storing server info
UUID	getServerUuid()
static UUID	getServerUUID()
TPSCountTimer	getTpsCountTimer()
ServerVariableHolder	getVariable() Used to get the object storing server variables that are constant after boot.
WebServer	getWebServer() Used to access WebServer.
void	onDisable() Disables the plugin.
void	onEnable() OnEnable method.
void	restart()

Methods inherited from class com.djrapitops.plugin.BukkitPlugin

benchmark, copyDefaultConfig, disablePlugin, fetch, getAPFVersion, getColorScheme, getIConfig, getInstance, getNotificationCenter, getPluginInstance, getPluginLogger, getPrefix, getRunnableFactory, getUpdateCheckUrl, getUpdateUrl, getVersion, onEnableDefaultTasks, registerCommand, registerListener, registerPluginMessageSubChannel, setColorScheme, setDebugMode, setInstance, setInstance, setLog, setLogPrefix, setUpdateCheckUrl, setUpdateUrl, taskStatus

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, onLoad, 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 main.java.com.djrapitops.plan.api.IPlan

getDataFolder, getIConfig, getResource

Methods inherited from interface com.djrapitops.plugin.IPlugin

benchmark, copyDefaultConfig, disablePlugin, fetch, getAPFVersion, getColorScheme, getNotificationCenter, getPluginLogger, getPrefix, getRunnableFactory, getUpdateCheckUrl, getUpdateUrl, getVersion, onEnableDefaultTasks, registerCommand, setColorScheme, setDebugMode, setLog, setLogPrefix, taskStatus

Constructor Detail

Plan

public Plan()

Method Detail

getPlanAPI

public static API getPlanAPI()
                      throws NoClassDefFoundError

Used to get the PlanAPI. @see API

Returns:

API of the current instance of Plan.

Throws:

IllegalStateException - If onEnable method has not been called on Plan and the instance is null.

NoClassDefFoundError - If Plan is not installed.

getInstance

public static Plan getInstance()

Used to get the plugin-instance singleton.

Returns:

this object.

getServerUUID

public static UUID getServerUUID()

getServerUuid

public UUID getServerUuid()

Specified by:

getServerUuid in interface IPlan

onEnable

public void onEnable()

OnEnable method.

- Enables the plugin's subsystems.

Specified by:

onEnable in interface com.djrapitops.plugin.IPlugin

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Specified by:

onEnable in class com.djrapitops.plugin.BukkitPlugin<Plan>

onDisable

public void onDisable()

Disables the plugin.

Specified by:

onDisable in interface com.djrapitops.plugin.IPlugin

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Specified by:

onDisable in class com.djrapitops.plugin.BukkitPlugin<Plan>

getDataCache

public DataCache getDataCache()

Used to access Cache.

Returns:

Current instance of the DataCache

getDB

public Database getDB()

Used to access active Database.

Specified by:

getDB in interface IPlan

Returns:

the Current Database

getWebServer

public WebServer getWebServer()

Used to access WebServer.

Specified by:

getWebServer in interface IPlan

Returns:

the WebServer

getHookHandler

public HookHandler getHookHandler()

Used to access HookHandler.

Returns:

HookHandler that manages Hooks to other plugins.

getDatabases

public Set<Database> getDatabases()

Used to get all possible database objects.

#init() might need to be called in order for the object to function.

Returns:

Set containing the SqLite and MySQL objects.

getBootAnalysisTaskID

public int getBootAnalysisTaskID()

Used to get the ID of the BootAnalysisTask, so that it can be disabled.

Returns:

ID of the bootAnalysisTask

getVariable

public ServerVariableHolder getVariable()

Used to get the object storing server variables that are constant after boot.

Specified by:

getVariable in interface IPlan

Returns:

ServerVariableHolder

See Also:

ServerVariableHolder

getServerInfoManager

public BukkitServerInfoManager getServerInfoManager()

Used to get the object storing server info

Returns:

BukkitServerInfoManager

See Also:

BukkitServerInfoManager

getProcessingQueue

public ProcessingQueue getProcessingQueue()

Specified by:

getProcessingQueue in interface IPlan

getTpsCountTimer

public TPSCountTimer getTpsCountTimer()

addToProcessQueue

public void addToProcessQueue(Processor... processors)

Specified by:

addToProcessQueue in interface IPlan

getInfoManager

public InformationManager getInfoManager()

Specified by:

getInfoManager in interface IPlan

restart

public void restart()

Specified by:

restart in interface IPlan