Package ch.tocco.nice2.usersettings.api

Interface Preferences

All Superinterfaces:

ReadOnlyMap<String>, WriteableMap<String>

All Known Implementing Classes:

PreferencesImpl

public interface Preferences
extends WriteableMap<String>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_FIELD
static final String	PATH_FIELD
static final String	PREF_ENTITY
static final String	VALUE_FIELD

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the preferences map.
Node	getNode()	The node identifying this preferences map.
boolean	isAutoFlush()
void	reload()	Reloads all values from the storage.
void	save()	Saves all changed values to the underlying storage.
void	setAutoFlush(boolean flag)	Sets the auto-flush property.
Map<String,String>	toMap()

Methods inherited from interface ch.tocco.nice2.toolbox.api.collection.ReadOnlyMap

containsKey, getBoolean, getBoolean, getDate, getDate, getDecimal, getDecimal, getDouble, getDouble, getEnum, getEnum, getFloat, getFloat, getInt, getInt, getLong, getLong, getString, getString, getValue, getValue, keySet

Methods inherited from interface ch.tocco.nice2.toolbox.api.collection.WriteableMap

removeValue, setBoolean, setDate, setDecimal, setDouble, setEnum, setFloat, setInt, setLong, setString, setValue

Field Details

KEY_FIELD

static final String KEY_FIELD

See Also:

• Constant Field Values

VALUE_FIELD

static final String VALUE_FIELD

See Also:

• Constant Field Values

PATH_FIELD

static final String PATH_FIELD

See Also:

• Constant Field Values

PREF_ENTITY

static final String PREF_ENTITY

See Also:

• Constant Field Values

Method Details

getNode

Node getNode()

The node identifying this preferences map.

setAutoFlush

void setAutoFlush(boolean flag)

Sets the auto-flush property. If set to true, each call to a setter will immediately cause saving all changed values.

Parameters:

flag - autoflush

isAutoFlush

boolean isAutoFlush()

Returns:

whether autoflush mode is enabled or not

save

void save()

Saves all changed values to the underlying storage.

reload

void reload()

Reloads all values from the storage. Note, that all changed values are lost.

clear

void clear()

Clears the preferences map. If not flushed, any unsaved changes that happened before the clear() are discarded. All changes after clear() are recorded as usual.

Specified by:

clear in interface WriteableMap<String>

toMap

Map<String,String> toMap()