main.java.com.djrapitops.plan

Class Plan

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

main.java.com.djrapitops.plan.Plan

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class Plan
extends org.bukkit.plugin.java.JavaPlugin

Javaplugin class that contains methods for starting the plugin, logging to the Bukkit console and various get methods.

Since:

1.0.0

Author:

Rsl1122

Constructor Summary

Constructors

Constructor and Description
Plan()

Method Summary

Modifier and Type	Method and Description
AnalysisCacheHandler	getAnalysisCache() Used to access AnalysisCache.
API	getAPI() Deprecated. Use Plan.getAPI() (static method) instead.
int	getBootAnalysisTaskID() Used to get the ID of the BootAnalysisTask, so that it can be disabled.
HashSet<Database>	getDatabases() Used to get all possible database objects.
Database	getDB() Used to access active Database.
DataCacheHandler	getHandler() Used to access Cache.
HookHandler	getHookHandler() Used to access HookHandler.
InspectCacheHandler	getInspectCache() Used to access InspectCache.
static Plan	getInstance() Used to get the current instance of Plan.
static API	getPlanAPI() Used to get the PlanAPI.
WebSocketServer	getUiServer() Used to access Webserver.
boolean	initDatabase() Initializes the database according to settings in the config.
void	onDisable() Disables the plugin.
void	onEnable() OnEnable method.
static void	setInstance(Plan plan) Used to set the current instance of Plan.

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, installDDL, isEnabled, isNaggable, onCommand, onLoad, onTabComplete, reloadConfig, removeDDL, 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

Constructor Detail

Plan

public Plan()

Method Detail

onEnable

public void onEnable()

OnEnable method. Creates the config file. Checks for new version. Initializes Database. Hooks to Supported plugins. Initializes DataCaches. Registers Listeners. Registers Command /plan and initializes API. Enables Webserver and analysis tasks if enabled in config. Warns about possible mistakes made in config.

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Disables the plugin. Stops the webserver, cancels all tasks and saves cache to the database.

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

initDatabase

public boolean initDatabase()

Initializes the database according to settings in the config. If database connection can not be established plugin is disabled.

Returns:

true if init was successful, false if not.

getAnalysisCache

public AnalysisCacheHandler getAnalysisCache()

Used to access AnalysisCache.

Returns:

Current instance of the AnalysisCacheHandler

getInspectCache

public InspectCacheHandler getInspectCache()

Used to access InspectCache.

Returns:

Current instance of the InspectCacheHandler

getHandler

public DataCacheHandler getHandler()

Used to access Cache.

Returns:

Current instance of the DataCacheHandler

getDB

public Database getDB()

Used to access active Database.

Returns:

the Current Database

getUiServer

public WebSocketServer getUiServer()

Used to access Webserver.

Returns:

the Webserver

getHookHandler

public HookHandler getHookHandler()

Used to access HookHandler.

Returns:

HookHandler that manages Hooks to other plugins.

getDatabases

public HashSet<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

getAPI

@Deprecated
public API getAPI()

Deprecated. Use Plan.getAPI() (static method) instead.

Old method for getting the API.

Returns:

the Plan API.

getInstance

public static Plan getInstance()

Used to get the current instance of Plan. Instance is set on the first line of onEnable method.

Returns:

current instance of Plan, Singleton.

Throws:

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

setInstance

public static void setInstance(Plan plan)

Used to set the current instance of Plan.

Parameters:

plan - The newly enabled Plan instance.

getPlanAPI

public static API getPlanAPI()
                      throws IllegalStateException

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.