Package ch.tocco.nice2.usersettings.impl

Class PreferencesImpl

java.lang.Object

ch.tocco.nice2.usersettings.impl.PreferencesImpl

All Implemented Interfaces:

ReadOnlyMap<String>, WriteableMap<String>, Preferences

public class PreferencesImpl
extends Object
implements Preferences

This implemenation maintains two maps: one is the initial map as specified when creating this object, the other one collects all changes tracked by the various setters. On each call of save() the two maps are merged and the new values are written to the backend.

This class is not thread safe. Use an instance from PreferencesFactory.getPreferences(Node) in each thread.

Field Summary

Fields inherited from interface ch.tocco.nice2.usersettings.api.Preferences

KEY_FIELD, PATH_FIELD, PREF_ENTITY, VALUE_FIELD

Constructor Summary

Constructors

Constructor	Description
PreferencesImpl(Node node, @Nullable Principal principal, Map<String,String> initialMap, PreferencesStore store)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the preferences map.
boolean	containsKey(String key)
Boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean fallback)
Date	getDate(String key)
Date	getDate(String key, Date fallback)
BigDecimal	getDecimal(String key)
BigDecimal	getDecimal(String key, BigDecimal fallback)
Double	getDouble(String key)
double	getDouble(String key, double fallback)
<S extends Enum<S>> S	getEnum(String key, Class<S> enumClass)
<S extends Enum<S>> S	getEnum(String key, Class<S> enumClass, S fallback)
Float	getFloat(String key)
float	getFloat(String key, float fallback)
Integer	getInt(String key)
int	getInt(String key, int fallback)
Long	getLong(String key)
long	getLong(String key, long fallback)
Node	getNode()	The node identifying this preferences map.
String	getString(String key)
String	getString(String key, String fallback)
<V> V	getValue(String key, Class<V> clazz)
<V> V	getValue(String key, Class<V> clazz, V fallback)
boolean	isAutoFlush()
Set<String>	keySet()	Returns an immutable view of all keys.
void	reload()	Reloads all values from the storage.
boolean	removeValue(String key)
void	save()	Saves all changed values to the underlying storage.
void	setAutoFlush(boolean flag)	Sets the auto-flush property.
boolean	setBoolean(String key, boolean bool)
boolean	setDate(String key, Date value)
boolean	setDecimal(String key, BigDecimal value)
boolean	setDouble(String key, double value)
boolean	setEnum(String key, Enum value)
boolean	setFloat(String key, float value)
boolean	setInt(String key, int value)
boolean	setLong(String key, long value)
boolean	setString(String key, String value)
boolean	setValue(String key, Object value)
Map<String,String>	toMap()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PreferencesImpl

public PreferencesImpl(Node node,
 @Nullable
 @Nullable Principal principal,
 Map<String,String> initialMap,
 PreferencesStore store)

Method Details

setValue

public boolean setValue(String key,
 Object value)

Specified by:

setValue in interface WriteableMap<String>

getValue

public <V> V getValue(String key,
 Class<V> clazz)

Specified by:

getValue in interface ReadOnlyMap<String>

getValue

public <V> V getValue(String key,
 Class<V> clazz,
 V fallback)

Specified by:

getValue in interface ReadOnlyMap<String>

getString

public String getString(String key,
 String fallback)

Specified by:

getString in interface ReadOnlyMap<String>

getString

public String getString(String key)

Specified by:

getString in interface ReadOnlyMap<String>

setString

public boolean setString(String key,
 String value)

Specified by:

setString in interface WriteableMap<String>

getInt

public int getInt(String key,
 int fallback)

Specified by:

getInt in interface ReadOnlyMap<String>

getInt

public Integer getInt(String key)

Specified by:

getInt in interface ReadOnlyMap<String>

setInt

public boolean setInt(String key,
 int value)

Specified by:

setInt in interface WriteableMap<String>

setLong

public boolean setLong(String key,
 long value)

Specified by:

setLong in interface WriteableMap<String>

getLong

public Long getLong(String key)

Specified by:

getLong in interface ReadOnlyMap<String>

getLong

public long getLong(String key,
 long fallback)

Specified by:

getLong in interface ReadOnlyMap<String>

getDouble

public double getDouble(String key,
 double fallback)

Specified by:

getDouble in interface ReadOnlyMap<String>

getDouble

public Double getDouble(String key)

Specified by:

getDouble in interface ReadOnlyMap<String>

setDouble

public boolean setDouble(String key,
 double value)

Specified by:

setDouble in interface WriteableMap<String>

getFloat

public float getFloat(String key,
 float fallback)

Specified by:

getFloat in interface ReadOnlyMap<String>

getFloat

public Float getFloat(String key)

Specified by:

getFloat in interface ReadOnlyMap<String>

setFloat

public boolean setFloat(String key,
 float value)

Specified by:

setFloat in interface WriteableMap<String>

getBoolean

public boolean getBoolean(String key,
 boolean fallback)

Specified by:

getBoolean in interface ReadOnlyMap<String>

getBoolean

public Boolean getBoolean(String key)

Specified by:

getBoolean in interface ReadOnlyMap<String>

setBoolean

public boolean setBoolean(String key,
 boolean bool)

Specified by:

setBoolean in interface WriteableMap<String>

getDecimal

public BigDecimal getDecimal(String key,
 BigDecimal fallback)

Specified by:

getDecimal in interface ReadOnlyMap<String>

getDecimal

public BigDecimal getDecimal(String key)

Specified by:

getDecimal in interface ReadOnlyMap<String>

setDecimal

public boolean setDecimal(String key,
 BigDecimal value)

Specified by:

setDecimal in interface WriteableMap<String>

getEnum

public <S extends Enum<S>> S getEnum(String key,
 Class<S> enumClass)

Specified by:

getEnum in interface ReadOnlyMap<String>

getEnum

public <S extends Enum<S>> S getEnum(String key,
 Class<S> enumClass,
 S fallback)

Specified by:

getEnum in interface ReadOnlyMap<String>

setEnum

public boolean setEnum(String key,
 Enum value)

Specified by:

setEnum in interface WriteableMap<String>

setDate

public boolean setDate(String key,
 Date value)

Specified by:

setDate in interface WriteableMap<String>

getDate

public Date getDate(String key)

Specified by:

getDate in interface ReadOnlyMap<String>

getDate

public Date getDate(String key,
 Date fallback)

Specified by:

getDate in interface ReadOnlyMap<String>

clear

public void clear()

Description copied from interface: Preferences

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 Preferences

Specified by:

clear in interface WriteableMap<String>

containsKey

public boolean containsKey(String key)

Specified by:

containsKey in interface ReadOnlyMap<String>

setAutoFlush

public void setAutoFlush(boolean flag)

Description copied from interface: Preferences

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

Specified by:

setAutoFlush in interface Preferences

Parameters:

flag - autoflush

isAutoFlush

public boolean isAutoFlush()

Specified by:

isAutoFlush in interface Preferences

Returns:

whether autoflush mode is enabled or not

toMap

public Map<String,String> toMap()

Specified by:

toMap in interface Preferences

save

public void save()

Description copied from interface: Preferences

Saves all changed values to the underlying storage.

Specified by:

save in interface Preferences

reload

public void reload()

Description copied from interface: Preferences

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

Specified by:

reload in interface Preferences

removeValue

public boolean removeValue(String key)

Specified by:

removeValue in interface WriteableMap<String>

keySet

public Set<String> keySet()

Description copied from interface: ReadOnlyMap

Returns an immutable view of all keys.

Specified by:

keySet in interface ReadOnlyMap<String>

getNode

public Node getNode()

Description copied from interface: Preferences

The node identifying this preferences map.

Specified by:

getNode in interface Preferences

toString

public String toString()

Overrides:

toString in class Object