com.austinv11.collectiveframework.minecraft.config

Interface IConfigurationHandler

All Known Implementing Classes:

ConfigRegistry.DefaultConfigurationHandler

public interface IConfigurationHandler

An interface representing a custom config handler, it will get called whenever a config is modified

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

Method Detail

setValue

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 setValue(String, String, Object, Object, boolean) but saveToFile is assumed true

Parameters:

configValue - The value being modified

category - The category the value is in

value - The new value

config - The config object

setValue

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

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

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

Called when a value is requested

Parameters:

configValue - The value being modified

category - The category the value is in

config - The config object

Returns:

The value

loadFile

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

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

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

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

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

Called to get the config file

Parameters:

fileName - The file name for the config

config - The config object

Returns:

The file representing the config

hasValue

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

Returns whether the config contains the specified value

Parameters:

configValue - The value

category - The category the value is in

Returns:

True if contained

convertToString

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

Converts the config into a string

Returns:

The config