net.malisis.core.configuration.setting

Class Setting<T>

java.lang.Object

net.malisis.core.configuration.setting.Setting<T>

Type Parameters:

T - the generic type

Direct Known Subclasses:

BooleanSetting, DoubleSetting, IntegerSetting, StringSetting

public abstract class Setting<T>
extends java.lang.Object

The Class Setting.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	category
protected java.lang.String[]	comments
protected T	defaultValue
protected java.lang.String	key
protected net.minecraftforge.common.config.Property	property
protected net.minecraftforge.common.config.Property.Type	type
protected T	value

Constructor Summary

Constructors

Constructor and Description
Setting(java.lang.String key, T defaultValue) Instantiates a new setting.

Method Summary

Modifier and Type	Method and Description
void	applySettingFromComponent()
T	get() Gets the value.
java.lang.String[]	getComments() Gets the comments.
abstract UIComponent<?>	getComponent(MalisisGui gui) Gets the component.
abstract T	getValueFromComponent() Gets the value from component.
void	load(net.minecraftforge.common.config.Configuration config) Loads the configuration.
abstract T	readValue(java.lang.String stringValue) Reads the value.
void	save() Save the configuration.
void	set(T value) Sets the value.
void	setCategory(java.lang.String category) Sets the category.
void	setComment(java.lang.String... comment) Sets the comment.
abstract java.lang.String	writeValue(T value) Writes the value.

Methods inherited from class java.lang.Object

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

Field Detail

property

protected net.minecraftforge.common.config.Property property

type

protected net.minecraftforge.common.config.Property.Type type

category

protected java.lang.String category

key

protected java.lang.String key

comments

protected java.lang.String[] comments

defaultValue

protected T defaultValue

value

protected T value

Constructor Detail

Setting

public Setting(java.lang.String key,
               T defaultValue)

Instantiates a new setting.

Parameters:

key - the key

defaultValue - the default value

Method Detail

setCategory

public void setCategory(java.lang.String category)

Sets the category.

Parameters:

category - the new category

setComment

public void setComment(java.lang.String... comment)

Sets the comment.

Parameters:

comment - the new comment

set

public void set(T value)

Sets the value.

Parameters:

value - the value

get

public T get()

Gets the value.

Returns:

the t

load

public void load(net.minecraftforge.common.config.Configuration config)

Loads the configuration.

Parameters:

config - the config

save

public void save()

Save the configuration.

getComments

public java.lang.String[] getComments()

Gets the comments.

Returns:

the comments

applySettingFromComponent

public void applySettingFromComponent()

readValue

public abstract T readValue(java.lang.String stringValue)

Reads the value.

Parameters:

stringValue - the string value

Returns:

the t

writeValue

public abstract java.lang.String writeValue(T value)

Writes the value.

Parameters:

value - the value

Returns:

the string

getComponent

public abstract UIComponent<?> getComponent(MalisisGui gui)

Gets the component.

Parameters:

gui - the gui

Returns:

the component

getValueFromComponent

public abstract T getValueFromComponent()

Gets the value from component.

Returns:

the value from component