com.austinv11.collectiveframework.minecraft.config

Class ConfigRegistry.DefaultConfigurationHandler

java.lang.Object

com.austinv11.collectiveframework.minecraft.config.ConfigRegistry.DefaultConfigurationHandler

All Implemented Interfaces:

IConfigurationHandler

Enclosing class:

ConfigRegistry

public static class ConfigRegistry.DefaultConfigurationHandler
extends java.lang.Object
implements IConfigurationHandler

The default IConfigurationHandler for configs

Constructor Summary

Constructors

Constructor and Description
ConfigRegistry.DefaultConfigurationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	convertToString(java.lang.Object config) Converts the config into a string
java.io.File	getConfigFile(java.lang.String fileName, java.lang.Object config) Called to get the config file
java.lang.Object	getValue(java.lang.String configValue, java.lang.String category, java.lang.Object config) Called when a value is requested
boolean	hasValue(java.lang.String configValue, java.lang.String category) Returns whether the config contains the specified value
void	loadFile(java.lang.String fileName, java.lang.Object config, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.reflect.Field>> hint) Called to load/create a config file
void	loadFromString(java.lang.String string, java.lang.Object config, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.reflect.Field>> hint) Called to load/create a config from a string
void	setValue(java.lang.String configValue, java.lang.String category, java.lang.Object value, java.lang.Object config) Called when a value is set/changed for a config, same as IConfigurationHandler.setValue(String, String, Object, Object, boolean) but saveToFile is assumed true
void	setValue(java.lang.String configValue, java.lang.String category, java.lang.Object value, java.lang.Object config, boolean saveToFile) Called when a value is set/changed for a config

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigRegistry.DefaultConfigurationHandler

public ConfigRegistry.DefaultConfigurationHandler()

Method Detail

setValue

public void setValue(java.lang.String configValue,
            java.lang.String category,
            java.lang.Object value,
            java.lang.Object config)

Description copied from interface: IConfigurationHandler

Called when a value is set/changed for a config, same as IConfigurationHandler.setValue(String, String, Object, Object, boolean) but saveToFile is assumed true

Specified by:

setValue in interface IConfigurationHandler

Parameters:

configValue - The value being modified

category - The category the value is in

value - The new value

config - The config object

setValue

public void setValue(java.lang.String configValue,
            java.lang.String category,
            java.lang.Object value,
            java.lang.Object config,
            boolean saveToFile)

Description copied from interface: IConfigurationHandler

Called when a value is set/changed for a config

Specified by:

setValue in interface IConfigurationHandler

Parameters:

configValue - The value being modified

category - The category the value is in

value - The new value

config - The config object

saveToFile - Whether to save the new value to the file

getValue

public java.lang.Object getValue(java.lang.String configValue,
                        java.lang.String category,
                        java.lang.Object config)

Description copied from interface: IConfigurationHandler

Called when a value is requested

Specified by:

getValue in interface IConfigurationHandler

Parameters:

configValue - The value being modified

category - The category the value is in

config - The config object

Returns:

The value

loadFile

public void loadFile(java.lang.String fileName,
            java.lang.Object config,
            java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.reflect.Field>> hint)

Description copied from interface: IConfigurationHandler

Called to load/create a config file

Specified by:

loadFile in interface IConfigurationHandler

Parameters:

fileName - The file name for the config

config - The config object

hint - A map full of field data (feel free to ignore this); Outer map has the key = the category Inner map has the key = the field name and the value = the actual field

loadFromString

public void loadFromString(java.lang.String string,
                  java.lang.Object config,
                  java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.reflect.Field>> hint)

Description copied from interface: IConfigurationHandler

Called to load/create a config from a string

Specified by:

loadFromString in interface IConfigurationHandler

Parameters:

string - The string containing all the data

config - The config object

hint - A map full of field data (feel free to ignore this); Outer map has the key = the category Inner map has the key = the field name and the value = the actual field

getConfigFile

public java.io.File getConfigFile(java.lang.String fileName,
                         java.lang.Object config)

Description copied from interface: IConfigurationHandler

Called to get the config file

Specified by:

getConfigFile in interface IConfigurationHandler

Parameters:

fileName - The file name for the config

config - The config object

Returns:

The file representing the config

hasValue

public boolean hasValue(java.lang.String configValue,
               java.lang.String category)

Description copied from interface: IConfigurationHandler

Returns whether the config contains the specified value

Specified by:

hasValue in interface IConfigurationHandler

Parameters:

configValue - The value

category - The category the value is in

Returns:

True if contained

convertToString

public java.lang.String convertToString(java.lang.Object config)

Description copied from interface: IConfigurationHandler

Converts the config into a string

Specified by:

convertToString in interface IConfigurationHandler

Returns:

The config