net.minecraftforge.common.config

Class FieldWrapper.SingleValueFieldWrapper

java.lang.Object

net.minecraftforge.common.config.FieldWrapper

net.minecraftforge.common.config.FieldWrapper.SingleValueFieldWrapper

All Implemented Interfaces:

IFieldWrapper

Direct Known Subclasses:

FieldWrapper.EnumWrapper, FieldWrapper.PrimitiveWrapper

Enclosing class:

FieldWrapper

private abstract static class FieldWrapper.SingleValueFieldWrapper
extends FieldWrapper

Nested Class Summary

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

FieldWrapper.BeanEntry<K,V>

Field Summary

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

category, field, instance, name

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SingleValueFieldWrapper(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()
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, boolean hasSlidingControl)

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

Methods inherited from interface net.minecraftforge.common.config.IFieldWrapper

getTypeAdapter, getValue, setupConfiguration, setValue

Constructor Detail

SingleValueFieldWrapper

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

Method Detail

getKeys

public java.lang.String[] getKeys()

Returns:

a list of fully qualified property keys handled by this field

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