Common (craftconomy3 3.3.1 API)

java.lang.Object
- com.greatmancode.craftconomy3.Common

All Implemented Interfaces:

com.greatmancode.tools.interfaces.Common
```
public class Common
extends java.lang.Object
implements com.greatmancode.tools.interfaces.Common
```
The core of Craftconomy. Every requests pass through this class

Constructor Summary

Constructors
Constructor and Description

Common()

Constructors
Constructor and Description
`Common()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMetricsGraph(java.lang.String title, boolean value)` Add a graph to Metrics
`void`	`addMetricsGraph(java.lang.String title, java.lang.String value)` Add a graph to Metrics
`java.lang.String`	`format(java.lang.String worldName, Currency currency, double balance)` Format a balance to a readable string with the default formatting.
`java.lang.String`	`format(java.lang.String worldName, Currency currency, double balance, DisplayFormat format)` Format a balance to a readable string.
`AccountManager`	`getAccountManager()` Retrieve the Account Manager.
`double`	`getBankPrice()` Retrieve the price of a bank account creation
`com.greatmancode.tools.commands.CommandHandler`	`getCommandManager()` Retrieve the Command Manager.
`com.greatmancode.tools.configuration.ConfigurationManager`	`getConfigurationManager()` Retrieve the Configuration Manager.
`CurrencyManager`	`getCurrencyManager()` Retrieve the Currency Manager.
`double`	`getDefaultHoldings()` Get the default amount of money a account will have
`DisplayFormat`	`getDisplayFormat()` Retrieve the display format for any formatting through `format(String, com.greatmancode.craftconomy3.currency.Currency, double, DisplayFormat)`
`EventManager`	`getEventManager()` Retrieve the Event manager.
`static Common`	`getInstance()` Retrieve the instance of Common.
`com.greatmancode.tools.language.LanguageManager`	`getLanguageManager()` Retrieve the `LanguageManager`
`java.util.logging.Logger`	`getLogger()` Retrieve the logger associated with this plugin.
`com.greatmancode.tools.configuration.Config`	`getMainConfig()` Retrieve the main configuration file
`com.greatmancode.tools.interfaces.caller.ServerCaller`	`getServerCaller()` Retrieve the Server Caller.
`StorageHandler`	`getStorageHandler()` Retrieve the Storage Handler.
`com.greatmancode.tools.utils.Updater`	`getVersionChecker()` Get the version Checker.
`WorldGroupsManager`	`getWorldGroupManager()` Retrieve the `WorldGroupsManager`
`void`	`initialiseDatabase()` Initialize the database Manager
`void`	`initializeCurrency()` Initialize the `CurrencyManager`
`void`	`initializeWorldGroup()` Initialize the `WorldGroupsManager`
`static boolean`	`isInitialized()` Check if the system has been initialized.
`void`	`loadDefaultSettings()` Reload the default settings.
`void`	`onDisable()` Disable the plugin.
`void`	`onEnable(com.greatmancode.tools.interfaces.caller.ServerCaller serverCaller, java.util.logging.Logger log)` Initialize the Common core.
`void`	`reloadPlugin()` Reload the plugin.
`void`	`sendConsoleMessage(java.util.logging.Level level, java.lang.String msg)` Sends a message to the console through the Logge.r
`void`	`setBankPrice(double value)` Set the bank account creation price
`void`	`setDefaultHoldings(double value)` Set the default amount of money a account will have
`void`	`setDisplayFormat(DisplayFormat format)` Set the display format for any formatting through `format(String, com.greatmancode.craftconomy3.currency.Currency, double, DisplayFormat)`
`void`	`startMetrics()` Start Metrics.
`void`	`startUp()` Initialize the `AccountManager`, Metrics and `EventManager`
`void`	`writeLog(LogInfo info, Cause cause, java.lang.String causeReason, Account account, double amount, Currency currency, java.lang.String worldName)` Write a transaction to the Log.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Common
```
public Common()
```
- Method Detail
  - onEnable
```
public void onEnable(com.greatmancode.tools.interfaces.caller.ServerCaller serverCaller,
                     java.util.logging.Logger log)
```
    Initialize the Common core.
    
    Specified by:
    
    onEnable in interface com.greatmancode.tools.interfaces.Common
  - onDisable
```
public void onDisable()
```
    Disable the plugin.
    
    Specified by:
    
    onDisable in interface com.greatmancode.tools.interfaces.Common
  - reloadPlugin
```
public void reloadPlugin()
```
    Reload the plugin.
  - getMainConfig
```
public com.greatmancode.tools.configuration.Config getMainConfig()
```
    Retrieve the main configuration file
    
    Returns:
    
    the main configuration file
  - getLogger
```
public java.util.logging.Logger getLogger()
```
    Retrieve the logger associated with this plugin.
    
    Returns:
    
    The logger instance.
  - sendConsoleMessage
```
public void sendConsoleMessage(java.util.logging.Level level,
                               java.lang.String msg)
```
    Sends a message to the console through the Logge.r
    
    Parameters:
    
    level - The log level to show.
    
    msg - The message to send.
  - getInstance
```
public static Common getInstance()
```
    Retrieve the instance of Common. Need to go through that to access any managers.
    
    Returns:
    
    The Common instance.
  - getAccountManager
```
public AccountManager getAccountManager()
```
    Retrieve the Account Manager.
    
    Returns:
    
    The Account Manager instance or null if the manager is not initialized.
  - getConfigurationManager
```
public com.greatmancode.tools.configuration.ConfigurationManager getConfigurationManager()
```
    Retrieve the Configuration Manager.
    
    Returns:
    
    The Configuration Manager instance or null if the manager is not initialized.
  - getStorageHandler
```
public StorageHandler getStorageHandler()
```
    Retrieve the Storage Handler.
    
    Returns:
    
    The Storage Handler instance or null if the handler is not initialized.
  - getCurrencyManager
```
public CurrencyManager getCurrencyManager()
```
    Retrieve the Currency Manager.
    
    Returns:
    
    The Currency Manager instance or null if the manager is not initialized.
  - getCommandManager
```
public com.greatmancode.tools.commands.CommandHandler getCommandManager()
```
    Retrieve the Command Manager.
    
    Returns:
    
    The Command Manager instance or null if the manager is not initialized.
  - getServerCaller
```
public com.greatmancode.tools.interfaces.caller.ServerCaller getServerCaller()
```
    Retrieve the Server Caller.
    
    Returns:
    
    The Server Caller instance or null if the caller is not initialized.
  - format
```
public java.lang.String format(java.lang.String worldName,
                               Currency currency,
                               double balance,
                               DisplayFormat format)
```
    Format a balance to a readable string.
    
    Parameters:
    
    worldName - The world Name associated with this balance
    
    currency - The currency instance associated with this balance.
    
    balance - The balance.
    
    format - the display format to use
    
    Returns:
    
    A pretty String showing the balance. Returns a empty string if currency is invalid.
  - format
```
public java.lang.String format(java.lang.String worldName,
                               Currency currency,
                               double balance)
```
    Format a balance to a readable string with the default formatting.
    
    Parameters:
    
    worldName - The world Name associated with this balance
    
    currency - The currency instance associated with this balance.
    
    balance - The balance.
    
    Returns:
    
    A pretty String showing the balance. Returns a empty string if currency is invalid.
  - initialiseDatabase
```
public void initialiseDatabase()
```
    Initialize the database Manager
  - initializeCurrency
```
public void initializeCurrency()
```
    Initialize the CurrencyManager
  - initializeWorldGroup
```
public void initializeWorldGroup()
```
    Initialize the WorldGroupsManager
  - startUp
```
public void startUp()
```
    Initialize the AccountManager, Metrics and EventManager
  - addMetricsGraph
```
public void addMetricsGraph(java.lang.String title,
                            java.lang.String value)
```
    Add a graph to Metrics
    
    Parameters:
    
    title - The title of the Graph
    
    value - The value of the entry
  - addMetricsGraph
```
public void addMetricsGraph(java.lang.String title,
                            boolean value)
```
    Add a graph to Metrics
    
    Parameters:
    
    title - The title of the Graph
    
    value - The value of the entry
  - startMetrics
```
public void startMetrics()
```
    Start Metrics.
  - writeLog
```
public void writeLog(LogInfo info,
                     Cause cause,
                     java.lang.String causeReason,
                     Account account,
                     double amount,
                     Currency currency,
                     java.lang.String worldName)
```
    Write a transaction to the Log.
    
    Parameters:
    
    info - The type of transaction to log.
    
    cause - The cause of the transaction.
    
    causeReason - The reason of the cause
    
    account - The account being impacted by the change
    
    amount - The amount of money in this transaction.
    
    currency - The currency associated with this transaction
    
    worldName - The world name associated with this transaction
  - getVersionChecker
```
public com.greatmancode.tools.utils.Updater getVersionChecker()
```
    Get the version Checker.
    
    Returns:
    
    The version checker. May return null if the system is disabled in the config.yml
  - getEventManager
```
public EventManager getEventManager()
```
    Retrieve the Event manager.
    
    Returns:
    
    The Event manager.
  - getLanguageManager
```
public com.greatmancode.tools.language.LanguageManager getLanguageManager()
```
    Retrieve the LanguageManager
    
    Returns:
    
    The LanguageManager
  - getWorldGroupManager
```
public WorldGroupsManager getWorldGroupManager()
```
    Retrieve the WorldGroupsManager
    
    Returns:
    
    The WorldGroupsManager
  - isInitialized
```
public static boolean isInitialized()
```
    Check if the system has been initialized.
    
    Returns:
    
    True if the system has been initialized else false.
  - loadDefaultSettings
```
public void loadDefaultSettings()
```
    Reload the default settings.
  - getDisplayFormat
```
public DisplayFormat getDisplayFormat()
```
    Retrieve the display format for any formatting through format(String, com.greatmancode.craftconomy3.currency.Currency, double, DisplayFormat)
    
    Returns:
    
    the display format used.
  - setDisplayFormat
```
public void setDisplayFormat(DisplayFormat format)
```
    Set the display format for any formatting through format(String, com.greatmancode.craftconomy3.currency.Currency, double, DisplayFormat)
    
    Parameters:
    
    format - The format display to be set to
  - getDefaultHoldings
```
public double getDefaultHoldings()
```
    Get the default amount of money a account will have
    
    Returns:
    
    the default amount of money
  - setDefaultHoldings
```
public void setDefaultHoldings(double value)
```
    Set the default amount of money a account will have
    
    Parameters:
    
    value - the default amount of money
  - getBankPrice
```
public double getBankPrice()
```
    Retrieve the price of a bank account creation
    
    Returns:
    
    The price of a bank account creation
  - setBankPrice
```
public void setBankPrice(double value)
```
    Set the bank account creation price
    
    Parameters:
    
    value - the bank account creation price

Class Common

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Common

Method Detail

onEnable

onDisable

reloadPlugin

getMainConfig

getLogger

sendConsoleMessage

getInstance

getAccountManager

getConfigurationManager

getStorageHandler

getCurrencyManager

getCommandManager

getServerCaller

format

format

initialiseDatabase

initializeCurrency

initializeWorldGroup

startUp

addMetricsGraph

addMetricsGraph

startMetrics

writeLog

getVersionChecker

getEventManager

getLanguageManager

getWorldGroupManager

isInitialized

loadDefaultSettings

getDisplayFormat

setDisplayFormat

getDefaultHoldings

setDefaultHoldings

getBankPrice

setBankPrice