com.communote.server.core.vo.user.preferences

Class UserPreference

java.lang.Object

com.communote.server.core.vo.user.preferences.UserPreference

Direct Known Subclasses:

UserInterfaceUserPreference

public abstract class UserPreference
extends Object

Abstract class, all concrete user preferences should implement.

Note: Implementing class must have an empty constructor to allow instantiation while runtime.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
UserPreference() Default constructor.
UserPreference(Map<String,String> preferences) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	getDefaults() Return the default values of this preference as a map.
Map<String,String>	getPreferences()
boolean	getValue(String key, boolean defaultValue)
byte	getValue(String key, byte defaultValue)
double	getValue(String key, double defaultValue)
float	getValue(String key, float defaultValue)
int	getValue(String key, int defaultValue)
long	getValue(String key, long defaultValue)
short	getValue(String key, short defaultValue)
String	getValue(String key, String defaultValue)
<T> T	getValueFromJson(String key, T defaultValue, Class<T> type) Method to get a more complex object from a JSON string.
void	setPreferences(Map<String,String> preferences) Method to set the preferences.
void	setValue(String key, Object value) Method to set the given object as value.
void	setValueToJson(String key, Object value) Method to set a more complex object explicitly as JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPreference

public UserPreference()

Default constructor.

UserPreference

public UserPreference(Map<String,String> preferences)

Constructor.

Parameters:

preferences - The preferences to load.

Method Detail

getDefaults

protected Map<String,String> getDefaults()

Return the default values of this preference as a map. This implementation returns an empty map.

Returns:

Map containing default values. The return value must not be null.

getPreferences

public Map<String,String> getPreferences()

Returns:

The preferences as map.

getValue

public boolean getValue(String key,
                        boolean defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as boolean (false, when empty).

getValue

public byte getValue(String key,
                     byte defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as byte or the default value.

getValue

public double getValue(String key,
                       double defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as double.

getValue

public float getValue(String key,
                      float defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as float.

getValue

public int getValue(String key,
                    int defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as int.

getValue

public long getValue(String key,
                     long defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as long.

getValue

public short getValue(String key,
                      short defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as short or the default value.

getValue

public String getValue(String key,
                       String defaultValue)

Parameters:

key - The key.

defaultValue - The default value to return.

Returns:

The value as String or empty String if null.

getValueFromJson

public <T> T getValueFromJson(String key,
                              T defaultValue,
                              Class<T> type)

Method to get a more complex object from a JSON string.

Note, that parsing is done on every request you do, so this might be slow on large objects. Also all parsing exceptions are logged and not thrown.

Type Parameters:

T - Type of the object.

Parameters:

key - The key.

defaultValue - The default value.

type - The type of the object.

Returns:

The object itself.

setPreferences

public void setPreferences(Map<String,String> preferences)

Method to set the preferences.

Parameters:

preferences - The preferences to set. These might overwrite existing ones.

setValue

public void setValue(String key,
                     Object value)

Method to set the given object as value. Use this only, if the object is some kind of primitive type and can easily be restored from a simple String.

Parameters:

key - The key.

value - The value to set. Use null to remove the value.

setValueToJson

public void setValueToJson(String key,
                           Object value)

Method to set a more complex object explicitly as JSON.

Note, that parsing is done on every request you do, so this might be slow on large objects. Also all parsing exceptions are logged and not thrown.

Parameters:

key - The key.

value - The value to be set, if null, the key will be removed.