net.minecraftforge.common.config

Class FieldWrapper.MapWrapper

java.lang.Object

net.minecraftforge.common.config.FieldWrapper

net.minecraftforge.common.config.FieldWrapper.MapWrapper

All Implemented Interfaces:

IFieldWrapper

Enclosing class:

FieldWrapper

private static class FieldWrapper.MapWrapper
extends FieldWrapper

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.common.config.FieldWrapper

FieldWrapper.BeanEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ITypeAdapter	adapter
private java.lang.String	baseName
private java.lang.reflect.Type	mType
private java.util.Map<java.lang.String,java.lang.Object>	theMap

Fields inherited from class net.minecraftforge.common.config.FieldWrapper

category, field, instance, name

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MapWrapper(java.lang.String category, java.lang.reflect.Field field, java.lang.Object instance)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory() i.e.
java.lang.String[]	getKeys()
private java.lang.String	getSuffix(java.lang.String key) Removes the this.baseName prefix from the key
ITypeAdapter	getTypeAdapter()
java.lang.Object	getValue(java.lang.String key)
boolean	handlesKey(java.lang.String key)
boolean	hasKey(java.lang.String key)
void	setupConfiguration(Configuration cfg, java.lang.String desc, java.lang.String langKey, boolean reqMCRestart, boolean reqWorldRestart)
void	setupConfiguration(Configuration cfg, java.lang.String desc, java.lang.String langKey, boolean reqMCRestart, boolean reqWorldRestart, boolean hasSlidingControl)
void	setValue(java.lang.String key, java.lang.Object value)

Methods inherited from class net.minecraftforge.common.config.FieldWrapper

get, hasWrapperFor

Methods inherited from class java.lang.Object

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

Field Detail

theMap

private java.util.Map<java.lang.String,java.lang.Object> theMap

mType

private java.lang.reflect.Type mType

baseName

private final java.lang.String baseName

adapter

ITypeAdapter adapter

Constructor Detail

MapWrapper

private MapWrapper(java.lang.String category,
                   java.lang.reflect.Field field,
                   java.lang.Object instance)

Method Detail

getTypeAdapter

public ITypeAdapter getTypeAdapter()

Returns:

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

getKeys

public java.lang.String[] getKeys()

Returns:

a list of fully qualified property keys handled by this field

getValue

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

Parameters:

key - the fully qualified property key

Returns:

the value the wrapped field associates with the given key

setValue

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

Parameters:

key - the fully qualified property key

value - the target value of the property associated with the key

hasKey

public boolean hasKey(java.lang.String key)

Parameters:

key - a fully qualified property key

Returns:

true if the wrapped field contains a property associated with the given key

handlesKey

public boolean handlesKey(java.lang.String key)

Parameters:

key - a fully qualified property key

Returns:

true if the wrapped field can save information associated with the given key, false otherwise

setupConfiguration

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

See Also:

IFieldWrapper.setupConfiguration(Configuration, String, String, boolean, boolean, boolean)

setupConfiguration

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

Parameters:

cfg - The configuration object holding the properties

desc - The properties description

langKey - The languageKey of the property, used in GUI

reqMCRestart - True, if a change in this property requires a restart of Minecraft

reqWorldRestart - True, if the world needs to be reloaded after changes to this property

hasSlidingControl - true if the property is going to have a slider control attached in the configuration UI; works in conjunction with Config.RangeInt and Config.RangeDouble

getCategory

public java.lang.String getCategory()

Description copied from interface: IFieldWrapper

i.e. general.map in the example above

Returns:

the category name in which the entries should be saved. This includes the parent categories

getSuffix

private java.lang.String getSuffix(java.lang.String key)

Removes the this.baseName prefix from the key

Parameters:

key - the key to be edited

Returns:

the keys suffix