gyurix.configfile

Class ConfigFile

java.lang.Object

gyurix.configfile.ConfigFile

public class ConfigFile
extends java.lang.Object

Data structure used for managing plugins configurations.

Field Summary

Fields

Modifier and Type	Field and Description
ConfigData	data The core of this ConfigFile
MySQLDatabase	db The MySQLDatabase settings used for storing and loading the configuration from MySQL
java.lang.String	dbArgs The MySQLDatabase settings used for storing and loading the configuration from MySQL
java.lang.String	dbKey The MySQLDatabase settings used for storing and loading the configuration from MySQL
java.lang.String	dbTable The MySQLDatabase settings used for storing and loading the configuration from MySQL
java.lang.String	dbValue The MySQLDatabase settings used for storing and loading the configuration from MySQL
java.io.File	file The file used for storing and loading the configuration

Constructor Summary

Constructors

Constructor and Description
ConfigFile() Constructs an empty ConfigFile
ConfigFile(ConfigData d) Wrap an already existing ConfigData
ConfigFile(java.io.File file) Constructs an empty ConfigFile and loads it from the given InputStream
ConfigFile(java.io.InputStream stream) Constructs an empty ConfigFile and loads it from the given InputStream
ConfigFile(MySQLDatabase mysql) Constructs an empty ConfigFile and loads it from MySQL
ConfigFile(MySQLDatabase mysql, java.lang.String table, java.lang.String key, java.lang.String value) Constructs an empty ConfigFile and loads it from MySQL
ConfigFile(java.lang.String in) Constructs an empty ConfigFile and loads it from the given String

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.String adress, java.lang.Class<T> cl) Get the given typed Object from the ConfigFiles given address.
<T> T	get(java.lang.String adress, java.lang.Class<T> cl, java.lang.reflect.Type... types) Get the given typed Object from the ConfigFiles given address.
boolean	getBoolean(java.lang.String address) Get a boolean variable from the configuration
boolean	getBoolean(java.lang.String address, boolean def) Get a boolean variable from the configuration
byte	getByte(java.lang.String address) Get a byte variable from the configuration
byte	getByte(java.lang.String address, byte def) Get a byte variable from the configuration
ConfigData	getData(java.lang.String address) Get data found in the given address
ConfigData	getData(java.lang.String address, boolean autoCreate) Get data found in the given address.
double	getDouble(java.lang.String address) Get a double variable from the configuration
double	getDouble(java.lang.String address, double def) Get a double variable from the configuration
float	getFloat(java.lang.String address) Get a float variable from the configuration
float	getFloat(java.lang.String address, float def) Get a float variable from the configuration
int	getInt(java.lang.String address) Get an int variable from the configuration
int	getInt(java.lang.String address, int def) Get an int variable from the configuration
long	getLong(java.lang.String address) Get a long variable from the configuration
long	getLong(java.lang.String address, long def) Get a long variable from the configuration
<T> T	getObject(java.lang.String adress, java.lang.Class<T> cl, T def, java.lang.reflect.Type... types) Get the given typed Object from the ConfigFile
<T> T	getObject(java.lang.String adress, java.lang.Class<T> cl, java.lang.reflect.Type... types) Get the given typed Object from the ConfigFile
short	getShort(java.lang.String address) Get a short variable from the configuration
short	getShort(java.lang.String address, short def) Get a short variable from the configuration
java.lang.String	getString(java.lang.String address) Get a String variable from the configuration
java.lang.String	getString(java.lang.String address, java.lang.String def) Get a String variable from the configuration
java.util.ArrayList<java.lang.String>	getStringKeyList() Get all the main sub keys of this configuration
java.util.ArrayList<java.lang.String>	getStringKeyList(java.lang.String key) Get all the main sub keys of this configuration which are under the root key
boolean	load(java.io.File f) Load configuration from a File
boolean	load(java.io.InputStream is) Load configuration from an InputStream
boolean	load(java.lang.String in) Load configuration from a String
void	mysqlLoad() Load the configuration from MySQL
void	mysqlLoad(java.lang.String address, java.lang.String args) Load the given address of this configuration from MySQL
void	mysqlUpdate(java.util.ArrayList<java.lang.String> l, java.lang.String args) Add to the given list the MySQL commands required for updating the storage based on this Configuration
boolean	reload() Reloads the configuration from the file used in initialization
boolean	removeData(java.lang.String address) Remove the given address from the configuration
boolean	save() Saves the configuration asynchronously.
boolean	save(java.io.OutputStream out) Saves the configuration to the given OutputStream.
boolean	saveNoAsync() Save the config file without using async thread.
void	serialize() Serializes the ConfigData for being able to throw all the object references
void	setData(java.lang.String address, ConfigData cd) Set the given the given address to the given ConfigData
void	setObject(java.lang.String address, java.lang.Object obj) Set the given address to the given Object.
void	setString(java.lang.String address, java.lang.String value) Set the given address to the given String.
ConfigFile	subConfig(java.lang.String address) Get the given sub section of this ConfigFile
ConfigFile	subConfig(java.lang.String address, java.lang.String dbArgs) Get the given sub section of this ConfigFile referring to
java.lang.String	toString() Convert this ConfigFile to a String

Methods inherited from class java.lang.Object

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

Field Detail

data

public ConfigData data

The core of this ConfigFile

db

public MySQLDatabase db

The MySQLDatabase settings used for storing and loading the configuration from MySQL

dbTable

public java.lang.String dbTable

The MySQLDatabase settings used for storing and loading the configuration from MySQL

dbKey

public java.lang.String dbKey

The MySQLDatabase settings used for storing and loading the configuration from MySQL

dbValue

public java.lang.String dbValue

The MySQLDatabase settings used for storing and loading the configuration from MySQL

dbArgs

public java.lang.String dbArgs

The MySQLDatabase settings used for storing and loading the configuration from MySQL

file

public java.io.File file

The file used for storing and loading the configuration

Constructor Detail

ConfigFile

public ConfigFile()

Constructs an empty ConfigFile

ConfigFile

public ConfigFile(java.io.InputStream stream)

Constructs an empty ConfigFile and loads it from the given InputStream

Parameters:

stream - - The InputStream containing the loadable configuration

ConfigFile

public ConfigFile(java.io.File file)

Constructs an empty ConfigFile and loads it from the given InputStream

Parameters:

file - - The File containing the loadable configuration

ConfigFile

public ConfigFile(MySQLDatabase mysql)

Constructs an empty ConfigFile and loads it from MySQL

Parameters:

mysql - - The MySQLDatabase containing the loadable configuration

ConfigFile

public ConfigFile(MySQLDatabase mysql,
                  java.lang.String table,
                  java.lang.String key,
                  java.lang.String value)

Constructs an empty ConfigFile and loads it from MySQL

Parameters:

mysql - - The MySQLDatabase containing the loadable configuration

table - - The table which contains the configuration, usually mysql.table

key - - The columns name which should be used for storing configurations addresses, usually "key"

value - - The columns name which should be used for storing configurations values, usually "value"

ConfigFile

public ConfigFile(java.lang.String in)

Constructs an empty ConfigFile and loads it from the given String

Parameters:

in - - The String containing the loadable configuration

ConfigFile

public ConfigFile(ConfigData d)

Wrap an already existing ConfigData

Parameters:

d - - The wrapable ConfigData

Method Detail

get

public <T> T get(java.lang.String adress,
                 java.lang.Class<T> cl)

Get the given typed Object from the ConfigFiles given address. If the given address does not exist then it will be created automatically

Type Parameters:

T - - The requested Objects type

Parameters:

adress - - The address

cl - - The requested Objects type

Returns:

The requested Object

get

public <T> T get(java.lang.String adress,
                 java.lang.Class<T> cl,
                 java.lang.reflect.Type... types)

Get the given typed Object from the ConfigFiles given address. If the given address does not exist then it will be created automatically

Type Parameters:

T - - The requested Objects type

Parameters:

adress - - The address

cl - - The requested Objects type

types - - The parameter types of the requested Object

Returns:

The requested Object

getBoolean

public boolean getBoolean(java.lang.String address,
                          boolean def)

Get a boolean variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested boolean variable or def it it was not found

getBoolean

public boolean getBoolean(java.lang.String address)

Get a boolean variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested byte variable or 0 if it was not found

getByte

public byte getByte(java.lang.String address,
                    byte def)

Get a byte variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested byte variable or def it it was not found

getByte

public byte getByte(java.lang.String address)

Get a byte variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested byte variable or 0 if it was not found

getData

public ConfigData getData(java.lang.String address)

Get data found in the given address

Parameters:

address - - Requested address

Returns:

The data found on the given address or empty ConfigData, if it can not be found.

getData

public ConfigData getData(java.lang.String address,
                          boolean autoCreate)

Get data found in the given address.

Parameters:

address - - Requested address

autoCreate - - Automatically create the road for accessing the given address

Returns:

The data found on the given address or empty ConfigData, if it can not be found.

getDouble

public double getDouble(java.lang.String address,
                        double def)

Get a double variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested double variable or def it it was not found

getDouble

public double getDouble(java.lang.String address)

Get a double variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested double variable or 0 if it was not found

getFloat

public float getFloat(java.lang.String address,
                      float def)

Get a float variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested float variable or def it it was not found

getFloat

public float getFloat(java.lang.String address)

Get a float variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested float variable or 0 if it was not found

getInt

public int getInt(java.lang.String address,
                  int def)

Get an int variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested int variable or def it it was not found

getInt

public int getInt(java.lang.String address)

Get an int variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested int variable or 0 if it was not found

getLong

public long getLong(java.lang.String address,
                    long def)

Get a long variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested long variable or def it it was not found

getLong

public long getLong(java.lang.String address)

Get a long variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested long variable or 0 if it was not found

getObject

public <T> T getObject(java.lang.String adress,
                       java.lang.Class<T> cl,
                       java.lang.reflect.Type... types)

Get the given typed Object from the ConfigFile

Type Parameters:

T - - The type of the Object

Parameters:

adress - - The address of the Object

cl - - The objects type

types - - Object type parameters

Returns:

The requested Object or null if it was not found.

getObject

public <T> T getObject(java.lang.String adress,
                       java.lang.Class<T> cl,
                       T def,
                       java.lang.reflect.Type... types)

Get the given typed Object from the ConfigFile

Type Parameters:

T - - The type of the Object

Parameters:

adress - - The address of the Object

cl - - The objects type

def - - Default return Object used, when Object can not be found under the given key

types - - Object type parameters

Returns:

The requested Object or def if it was not found.

getShort

public short getShort(java.lang.String address,
                      short def)

Get a short variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested short variable or def it it was not found

getShort

public short getShort(java.lang.String address)

Get a short variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested short variable or 0 if it was not found

getString

public java.lang.String getString(java.lang.String address,
                                  java.lang.String def)

Get a String variable from the configuration

Parameters:

address - - The address used for storing the value

def - - Default value which should be returned if the address does not exist

Returns:

The requested String variable or def it it was not found

getString

public java.lang.String getString(java.lang.String address)

Get a String variable from the configuration

Parameters:

address - - The address used for storing the value

Returns:

The requested String variable or empty string if it was not found

getStringKeyList

public java.util.ArrayList<java.lang.String> getStringKeyList()

Get all the main sub keys of this configuration

Returns:

The list of main sub keys of this configuration

getStringKeyList

public java.util.ArrayList<java.lang.String> getStringKeyList(java.lang.String key)

Get all the main sub keys of this configuration which are under the root key

Parameters:

key - - Root key

Returns:

The list of main sub keys under the root key

load

public boolean load(java.io.InputStream is)

Load configuration from an InputStream

Parameters:

is - - The loadable InputStream

Returns:

The success of the load

load

public boolean load(java.lang.String in)

Load configuration from a String

Parameters:

in - - The loadable String

Returns:

The success of the load

load

public boolean load(java.io.File f)

Load configuration from a File

Parameters:

f - - The loadable File

Returns:

The success of the load

mysqlLoad

public void mysqlLoad(java.lang.String address,
                      java.lang.String args)

Load the given address of this configuration from MySQL

Parameters:

address - - The loadable address

args - - Arguments of the MySQL WHERE clause

mysqlLoad

public void mysqlLoad()

Load the configuration from MySQL

mysqlUpdate

public void mysqlUpdate(java.util.ArrayList<java.lang.String> l,
                        java.lang.String args)

Add to the given list the MySQL commands required for updating the storage based on this Configuration

Parameters:

l - - The list

args - - The arguments which should be passed after MySQL WHERE clause.

reload

public boolean reload()

Reloads the configuration from the file used in initialization

Returns:

The success of reload

removeData

public boolean removeData(java.lang.String address)

Remove the given address from the configuration

Parameters:

address - - The removable address

Returns:

True if the data was removed, false otherwise

save

public boolean save()

Saves the configuration asynchronously.

Returns:

The success rate of the saving.

save

public boolean save(java.io.OutputStream out)

Saves the configuration to the given OutputStream.

Returns:

The success rate of the saving.

saveNoAsync

public boolean saveNoAsync()

Save the config file without using async thread.

Returns:

The sucess rate of the saving

serialize

public void serialize()

Serializes the ConfigData for being able to throw all the object references

setData

public void setData(java.lang.String address,
                    ConfigData cd)

Set the given the given address to the given ConfigData

Parameters:

address - - The changable address

cd - - Target ConfigData

setObject

public void setObject(java.lang.String address,
                      java.lang.Object obj)

Set the given address to the given Object.

Parameters:

address - - The setable address

obj - - Target Object

setString

public void setString(java.lang.String address,
                      java.lang.String value)

Set the given address to the given String.

Parameters:

address - - The setable address

value - - Target String

subConfig

public ConfigFile subConfig(java.lang.String address)

Get the given sub section of this ConfigFile

Parameters:

address - - Sub sections address

Returns:

The requested sub section of this ConfigFile

subConfig

public ConfigFile subConfig(java.lang.String address,
                            java.lang.String dbArgs)

Get the given sub section of this ConfigFile referring to

Parameters:

address - - Sub sections address

dbArgs - - The MySQL arguments which should be used for saving this sub section

Returns:

The requested sub section of this ConfigFile

toString

public java.lang.String toString()

Convert this ConfigFile to a String

Overrides:

toString in class java.lang.Object

Returns:

The same result as data.toString()