com.alexvasilkov.android.commons.prefs

Class PreferencesHelper

java.lang.Object

com.alexvasilkov.android.commons.prefs.PreferencesHelper

public class PreferencesHelper
extends java.lang.Object

Helper methods to store additional types of values to SharedPreferences.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DELIMITER

Method Summary

Modifier and Type	Method and Description
static java.util.Date	getDate(android.content.SharedPreferences prefs, java.lang.String key) Retrieves date value stored as long.
static double	getDouble(android.content.SharedPreferences prefs, java.lang.String key, double defaultValue) Retrieves double value stored as long.
static <T> T	getJson(android.content.SharedPreferences prefs, java.lang.String key, java.lang.Class<T> clazz) Retrieves object stored as json encoded string.
static <T> T	getJson(android.content.SharedPreferences prefs, java.lang.String key, java.lang.reflect.Type type) Retrieves object stored as json encoded string.
static java.io.Serializable	getSerializable(android.content.SharedPreferences prefs, java.lang.String key) Retrieves serializable object stored as BASE_64 encoded string.
static java.lang.String[]	getStringArray(android.content.SharedPreferences prefs, java.lang.String key) Retrieves strings array stored as single string.
static java.lang.String[]	getStringArray(android.content.SharedPreferences prefs, java.lang.String key, java.lang.String delimiter) Retrieves strings array stored as single string.
static android.content.SharedPreferences.Editor	putDate(android.content.SharedPreferences.Editor editor, java.lang.String key, java.util.Date value) Stores given date as long value.
static android.content.SharedPreferences.Editor	putDouble(android.content.SharedPreferences.Editor editor, java.lang.String key, double value) Converts and stores double value as long.
static android.content.SharedPreferences.Editor	putJson(android.content.SharedPreferences.Editor editor, java.lang.String key, java.lang.Object obj) Stores object as json encoded string.
static android.content.SharedPreferences.Editor	putSerializable(android.content.SharedPreferences.Editor editor, java.lang.String key, java.io.Serializable obj) Stores serializable object as BASE_64 encoded string.
static android.content.SharedPreferences.Editor	putStringArray(android.content.SharedPreferences.Editor editor, java.lang.String key, java.lang.String[] values) Stores strings array as single string.
static android.content.SharedPreferences.Editor	putStringArray(android.content.SharedPreferences.Editor editor, java.lang.String key, java.lang.String[] values, java.lang.String delimiter) Stores strings array as single string.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELIMITER

public static final java.lang.String DEFAULT_DELIMITER

See Also:

Constant Field Values

Method Detail

putDouble

public static android.content.SharedPreferences.Editor putDouble(android.content.SharedPreferences.Editor editor,
                                                                 java.lang.String key,
                                                                 double value)

Converts and stores double value as long.

getDouble

public static double getDouble(android.content.SharedPreferences prefs,
                               java.lang.String key,
                               double defaultValue)

Retrieves double value stored as long.

putDate

public static android.content.SharedPreferences.Editor putDate(android.content.SharedPreferences.Editor editor,
                                                               java.lang.String key,
                                                               java.util.Date value)

Stores given date as long value. Long.MIN_VALUE is used if date is null.

getDate

public static java.util.Date getDate(android.content.SharedPreferences prefs,
                                     java.lang.String key)

Retrieves date value stored as long.

putStringArray

public static android.content.SharedPreferences.Editor putStringArray(android.content.SharedPreferences.Editor editor,
                                                                      java.lang.String key,
                                                                      java.lang.String[] values,
                                                                      java.lang.String delimiter)

Stores strings array as single string.

Parameters:

delimiter - Delimiter used for strings concatination.

putStringArray

public static android.content.SharedPreferences.Editor putStringArray(android.content.SharedPreferences.Editor editor,
                                                                      java.lang.String key,
                                                                      java.lang.String[] values)

Stores strings array as single string. Uses DEFAULT_DELIMITER as delimiter.

getStringArray

public static java.lang.String[] getStringArray(android.content.SharedPreferences prefs,
                                                java.lang.String key,
                                                java.lang.String delimiter)

Retrieves strings array stored as single string.

Parameters:

delimiter - Delimiter used to split the string.

getStringArray

public static java.lang.String[] getStringArray(android.content.SharedPreferences prefs,
                                                java.lang.String key)

Retrieves strings array stored as single string. Uses DEFAULT_DELIMITER as delimiter.

putSerializable

public static android.content.SharedPreferences.Editor putSerializable(android.content.SharedPreferences.Editor editor,
                                                                       java.lang.String key,
                                                                       java.io.Serializable obj)

Stores serializable object as BASE_64 encoded string.

getSerializable

public static java.io.Serializable getSerializable(android.content.SharedPreferences prefs,
                                                   java.lang.String key)

Retrieves serializable object stored as BASE_64 encoded string.

putJson

public static android.content.SharedPreferences.Editor putJson(android.content.SharedPreferences.Editor editor,
                                                               java.lang.String key,
                                                               java.lang.Object obj)

Stores object as json encoded string. Gson library should be available in classpath.

getJson

public static <T> T getJson(android.content.SharedPreferences prefs,
                            java.lang.String key,
                            java.lang.Class<T> clazz)

Retrieves object stored as json encoded string. Gson library should be available in classpath.

getJson

public static <T> T getJson(android.content.SharedPreferences prefs,
                            java.lang.String key,
                            java.lang.reflect.Type type)

Retrieves object stored as json encoded string. Gson library should be available in classpath.