Package com.burchard36.api

Class BurchAPI

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.burchard36.api.BurchAPI

All Implemented Interfaces:

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

public abstract class BurchAPI
extends org.bukkit.plugin.java.JavaPlugin

Users of this API are expected to extend this class, rather than JavaPlugin, BurchAPI will provide methods for JavaPlugin

Since:

2.1.5

Author:

Dalton Burchard

Field Summary

Fields

Modifier and Type	Field	Description
protected ApiSettings	apiSettings
static BurchAPI	INSTANCE
protected GlobalInventoryListener	inventoryListener
protected PluginJsonWriter	jsonWriter

Constructor Summary

Constructors

Constructor	Description
BurchAPI()

Method Summary

Modifier and Type	Method	Description
static String	convert(String message)	Converts a normal string to a formatted one
static List<String>	convert(String... message)	Converts a varargs String to colored List of String's
GlobalInventoryListener	getGlobalInventoryListener()
PluginJsonWriter	getJsonWriter()	Gets the PluginJsonWriter instance of this class
<T> PackageScanner<T>	getPackageScanner()	Gets a new PackageScanner instance
boolean	isDebug()	Returns whether the Api is in debug state, this is generally used for the Logger If you are extending this class, you can Override this method.
String	loggerPrefix()	Returns the logger prefix for Logger If your class is extending this class, you can Override this method to change the output.
void	onDisable()
void	onEnable()
void	onPluginDisable()	Calls after the API disables itself
void	onPluginEnable()	Calls after the API enables itself
abstract void	onPreApiEnable()	Plugins can override this and change certain aspects of the API functionality before api initialization

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

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, 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

Field Details

INSTANCE

public static BurchAPI INSTANCE

inventoryListener

protected GlobalInventoryListener inventoryListener

jsonWriter

protected PluginJsonWriter jsonWriter

apiSettings

protected final ApiSettings apiSettings

Constructor Details

BurchAPI

public BurchAPI()

Method Details

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

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

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

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

onPreApiEnable

public abstract void onPreApiEnable()

Plugins can override this and change certain aspects of the API functionality before api initialization

Since:

2.1.5

getJsonWriter

public final PluginJsonWriter getJsonWriter()

Gets the PluginJsonWriter instance of this class

Returns:

the instance of PluginJsonWriter

isDebug

public boolean isDebug()

Returns whether the Api is in debug state, this is generally used for the Logger If you are extending this class, you can Override this method.

Returns:

A Boolean true if debugging is active

loggerPrefix

public String loggerPrefix()

Returns the logger prefix for Logger If your class is extending this class, you can Override this method to change the output.

Returns:

Any String

getGlobalInventoryListener

public final GlobalInventoryListener getGlobalInventoryListener()

getPackageScanner

public final <T> PackageScanner<T> getPackageScanner()

Gets a new PackageScanner instance

Returns:

A new generic PackageScanner

convert

public static String convert(String message)

Converts a normal string to a formatted one

Parameters:

message - Any String to convert

Returns:

Converted String

Since:

2.1.5

convert

public static List<String> convert(String... message)

Converts a varargs String to colored List of String's

Parameters:

message - Varargs of any String to convert to colored format using ampersand color codes

Returns:

A List of colored String's (using ampersand color codes)

Since:

2.1.5

onPluginEnable

void onPluginEnable()

Calls after the API enables itself

Since:

2.1.5

onPluginDisable

void onPluginDisable()

Calls after the API disables itself

Since:

2.1.5