net.minecraftforge.common.config

Interface IFieldWrapper

All Known Implementing Classes:

FieldWrapper

public interface IFieldWrapper

The objects are expected to get their wrapped field, the owning class, instance and category string on initialization.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory()
java.lang.String[]	getKeys()
net.minecraftforge.common.config.ITypeAdapter	getTypeAdapter()
java.lang.Object	getValue(java.lang.String key)
boolean	handlesKey(java.lang.String name)
boolean	hasKey(java.lang.String name)
void	setupConfiguration(Configuration cfg, java.lang.String desc, java.lang.String langKey, boolean reqMCRestart, boolean reqWorldRestart)
void	setValue(java.lang.String key, java.lang.Object value)

Method Detail

getTypeAdapter

net.minecraftforge.common.config.ITypeAdapter getTypeAdapter()

Returns:

The type adapter to serialize the values returned by getValue. Null if non-primitive.

getKeys

java.lang.String[] getKeys()

Parameters:

field - the field about which to retrieve information

instance - The instance whose field shall be queried.

Returns:

a list of keys handled by this field

getValue

java.lang.Object getValue(java.lang.String key)

setValue

void setValue(java.lang.String key,
              java.lang.Object value)

hasKey

boolean hasKey(java.lang.String name)

handlesKey

boolean handlesKey(java.lang.String name)

setupConfiguration

void setupConfiguration(Configuration cfg,
                        java.lang.String desc,
                        java.lang.String langKey,
                        boolean reqMCRestart,
                        boolean reqWorldRestart)

getCategory

java.lang.String getCategory()

Returns:

the category name in which the entries should be saved.