de.torqdev.easysettings.core

Interface Settings

All Known Implementing Classes:

SettingsImpl

public interface Settings

This interface is meant to be the main connection to your application.

Version:

1.0

Author:

Christopher Guckes

Method Summary

Modifier and Type	Method and Description
<T> void	addChoiceSetting(String key, ChoiceSetting<T> setting) Adds an ChoiceSetting to the settings container.
void	addFileSetting(String key, FileSetting setting) Adds an FileSetting to the settings container.
<T> void	addMultiselectSetting(String key, MultiselectSetting<T> setting) Adds an MultiselectSetting to the settings container.
<T extends Number> void	addRangeSetting(String key, RangeSetting<T> setting) Adds an RangeSetting to the settings container.
<T> void	addUnboundedSetting(String key, UnboundedSetting<T> setting) Adds an UnboundedSetting to the settings container.
<T> ChoiceSetting<T>	getChoiceSetting(String key) Returns the ChoiceSetting with the specified key.
FileSetting	getFileSetting(String key) Returns the FileSetting with the specified key.
<T> MultiselectSetting<T>	getMultiselectSetting(String key) Returns the MultiselectSetting with the specified key.
<T extends Number> RangeSetting<T>	getRangeSetting(String key) Returns the RangeSetting with the specified key.
<T> Setting<T>	getSetting(String key) Returns the value associated with the specified key.
Map<String,SettingType>	getSettingTypes() This function allows you to get all setting types by key.
<T> UnboundedSetting<T>	getUnboundedSetting(String key) Returns the UnboundedSetting with the specified key.
void	load() Loads all settings from the persistence layer and updates the provided default values.
void	save() Saves all settings stored in this container to the persistence layer.

Method Detail

getSetting

<T> Setting<T> getSetting(String key)

Returns the value associated with the specified key.

Type Parameters:

T - the type of value you want to

Parameters:

key - the name of the setting you want to query

Returns:

the value stored in the setting with the specified key

getUnboundedSetting

<T> UnboundedSetting<T> getUnboundedSetting(String key)

Returns the UnboundedSetting with the specified key.

Type Parameters:

T - The value type you want to fetch

Parameters:

key - the name of the setting you want to query

Returns:

the setting with the specified key

addUnboundedSetting

<T> void addUnboundedSetting(String key,
                             UnboundedSetting<T> setting)

Adds an UnboundedSetting to the settings container.

Type Parameters:

T - the type of value the setting should contain

Parameters:

key - the key to store the value to

setting - the UnboundedSetting you want to store

getChoiceSetting

<T> ChoiceSetting<T> getChoiceSetting(String key)

Returns the ChoiceSetting with the specified key.

Type Parameters:

T - The value type you want to fetch

Parameters:

key - the name of the setting you want to query

Returns:

the setting with the specified key

addChoiceSetting

<T> void addChoiceSetting(String key,
                          ChoiceSetting<T> setting)

Adds an ChoiceSetting to the settings container.

Type Parameters:

T - the type of value the setting should contain

Parameters:

key - the key to store the value to

setting - the ChoiceSetting you want to store

getRangeSetting

<T extends Number> RangeSetting<T> getRangeSetting(String key)

Returns the RangeSetting with the specified key.

Type Parameters:

T - The value type you want to fetch

Parameters:

key - the name of the setting you want to query

Returns:

the setting with the specified key

addRangeSetting

<T extends Number> void addRangeSetting(String key,
                                        RangeSetting<T> setting)

Adds an RangeSetting to the settings container.

Type Parameters:

T - the type of value the setting should contain

Parameters:

key - the key to store the value to

setting - the RangeSetting you want to store

getFileSetting

FileSetting getFileSetting(String key)

Returns the FileSetting with the specified key.

Parameters:

key - the name of the setting you want to query

Returns:

the FileSetting with the specified key

addFileSetting

void addFileSetting(String key,
                    FileSetting setting)

Adds an FileSetting to the settings container.

Parameters:

key - the key to store the value to

setting - the FileSetting you want to store

getMultiselectSetting

<T> MultiselectSetting<T> getMultiselectSetting(String key)

Returns the MultiselectSetting with the specified key.

Type Parameters:

T - The value type you want to fetch

Parameters:

key - the name of the setting you want to query

Returns:

the setting with the specified key

addMultiselectSetting

<T> void addMultiselectSetting(String key,
                               MultiselectSetting<T> setting)

Adds an MultiselectSetting to the settings container.

Type Parameters:

T - the type of value the setting should contain

Parameters:

key - the key to store the value to

setting - the MultiselectSetting you want to store

getSettingTypes

Map<String,SettingType> getSettingTypes()

This function allows you to get all setting types by key. That way you can decide yourself, which function you want to call. This is mainly to be used for user interfaces, not so much your business logic.

Returns:

all setting types by key

save

void save()

Saves all settings stored in this container to the persistence layer.

load

void load()

Loads all settings from the persistence layer and updates the provided default values. This should be run after all settings have been added.