com.pixplicity.easyprefs.library

Class Prefs

java.lang.Object

com.pixplicity.easyprefs.library.Prefs

public final class Prefs
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Prefs.Builder Builder class for the EasyPrefs instance.

Constructor Summary

Constructors

Constructor and Description
Prefs()

Method Summary

Modifier and Type	Method and Description
static android.content.SharedPreferences.Editor	clear() Removed all the stored keys and values.
static boolean	contains(java.lang.String key) Checks if a value is stored for the given key.
static android.content.SharedPreferences.Editor	edit() Returns the Editor of the underlying SharedPreferences instance.
static java.util.Map<java.lang.String,?>	getAll()
static boolean	getBoolean(java.lang.String key, boolean defValue) Retrieves a stored boolean value.
static double	getDouble(java.lang.String key, double defValue) Returns the double that has been saved as a long raw bits value in the long preferences.
static float	getFloat(java.lang.String key, float defValue) Retrieves a stored float value.
static int	getInt(java.lang.String key, int defValue) Retrieves a stored int value.
static long	getLong(java.lang.String key, long defValue) Retrieves a stored long value.
static java.util.Set<java.lang.String>	getOrderedStringSet(java.lang.String key, java.util.Set<java.lang.String> defValue) Retrieves a Set of Strings as stored by putOrderedStringSet(String, Set), preserving the original order.
static android.content.SharedPreferences	getPreferences() Returns the underlying SharedPreference instance
static java.lang.String	getString(java.lang.String key, java.lang.String defValue) Retrieves a stored String value.
static java.util.Set<java.lang.String>	getStringSet(java.lang.String key, java.util.Set<java.lang.String> defValue) Retrieves a Set of Strings as stored by putStringSet(String, Set).
static void	initPrefs(android.content.Context context) Deprecated.
static void	putBoolean(java.lang.String key, boolean value) Stores a boolean value.
static void	putDouble(java.lang.String key, double value) Stores a double value as a long raw bits value.
static void	putFloat(java.lang.String key, float value) Stores a float value.
static void	putInt(java.lang.String key, int value) Stores an integer value.
static void	putLong(java.lang.String key, long value) Stores a long value.
static void	putOrderedStringSet(java.lang.String key, java.util.Set<java.lang.String> value) Stores a Set of Strings, preserving the order.
static void	putString(java.lang.String key, java.lang.String value) Stores a String value.
static void	putStringSet(java.lang.String key, java.util.Set<java.lang.String> value) Stores a Set of Strings.
static void	remove(java.lang.String key) Removes a preference value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Prefs

public Prefs()

Method Detail

initPrefs

@Deprecated
public static void initPrefs(android.content.Context context)

Deprecated.

Initialize the Prefs helper class to keep a reference to the SharedPreference for this application the SharedPreference will use the package name of the application as the Key. This method is deprecated please us the new builder.

Parameters:

context - the Application context.

getPreferences

public static android.content.SharedPreferences getPreferences()

Returns the underlying SharedPreference instance

Returns:

an instance of the SharedPreference

Throws:

java.lang.RuntimeException - if SharedPreference instance has not been instantiated yet.

getAll

public static java.util.Map<java.lang.String,?> getAll()

Returns:

Returns a map containing a list of pairs key/value representing the preferences.

See Also:

SharedPreferences.getAll()

getInt

public static int getInt(java.lang.String key,
                         int defValue)

Retrieves a stored int value.

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValue.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not an int.

See Also:

SharedPreferences.getInt(String, int)

getBoolean

public static boolean getBoolean(java.lang.String key,
                                 boolean defValue)

Retrieves a stored boolean value.

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValue.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a boolean.

See Also:

SharedPreferences.getBoolean(String, boolean)

getLong

public static long getLong(java.lang.String key,
                           long defValue)

Retrieves a stored long value.

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValue.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a long.

See Also:

SharedPreferences.getLong(String, long)

getDouble

public static double getDouble(java.lang.String key,
                               double defValue)

Returns the double that has been saved as a long raw bits value in the long preferences.

Parameters:

key - The name of the preference to retrieve.

defValue - the double Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValue.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a long.

See Also:

SharedPreferences.getLong(String, long)

getFloat

public static float getFloat(java.lang.String key,
                             float defValue)

Retrieves a stored float value.

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValue.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a float.

See Also:

SharedPreferences.getFloat(String, float)

getString

public static java.lang.String getString(java.lang.String key,
                                         java.lang.String defValue)

Retrieves a stored String value.

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValue.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a String.

See Also:

SharedPreferences.getString(String, String)

getStringSet

public static java.util.Set<java.lang.String> getStringSet(java.lang.String key,
                                                           java.util.Set<java.lang.String> defValue)

Retrieves a Set of Strings as stored by putStringSet(String, Set). On Honeycomb and later this will call the native implementation in SharedPreferences, on older SDKs this will call getOrderedStringSet(String, Set). Note that the native implementation of SharedPreferences.getStringSet(String, Set) does not reliably preserve the order of the Strings in the Set.

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference values if they exist, or defValues otherwise.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a Set.

See Also:

SharedPreferences.getStringSet(String, java.util.Set), getOrderedStringSet(String, Set)

getOrderedStringSet

public static java.util.Set<java.lang.String> getOrderedStringSet(java.lang.String key,
                                                                  java.util.Set<java.lang.String> defValue)

Retrieves a Set of Strings as stored by putOrderedStringSet(String, Set), preserving the original order. Note that this implementation is heavier than the native getStringSet(String, Set) method (which does not guarantee to preserve order).

Parameters:

key - The name of the preference to retrieve.

defValue - Value to return if this preference does not exist.

Returns:

Returns the preference value if it exists, or defValues otherwise.

Throws:

java.lang.ClassCastException - if there is a preference with this name that is not a Set of Strings.

See Also:

getStringSet(String, Set)

putLong

public static void putLong(java.lang.String key,
                           long value)

Stores a long value.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

SharedPreferences.Editor.putLong(String, long)

putInt

public static void putInt(java.lang.String key,
                          int value)

Stores an integer value.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

SharedPreferences.Editor.putInt(String, int)

putDouble

public static void putDouble(java.lang.String key,
                             double value)

Stores a double value as a long raw bits value.

Parameters:

key - The name of the preference to modify.

value - The double value to be save in the preferences.

See Also:

SharedPreferences.Editor.putLong(String, long)

putFloat

public static void putFloat(java.lang.String key,
                            float value)

Stores a float value.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

SharedPreferences.Editor.putFloat(String, float)

putBoolean

public static void putBoolean(java.lang.String key,
                              boolean value)

Stores a boolean value.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

SharedPreferences.Editor.putBoolean(String, boolean)

putString

public static void putString(java.lang.String key,
                             java.lang.String value)

Stores a String value.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

SharedPreferences.Editor.putString(String, String)

putStringSet

public static void putStringSet(java.lang.String key,
                                java.util.Set<java.lang.String> value)

Stores a Set of Strings. On Honeycomb and later this will call the native implementation in SharedPreferences.Editor, on older SDKs this will call putOrderedStringSet(String, Set). Note that the native implementation of SharedPreferences.Editor.putStringSet(String, Set) does not reliably preserve the order of the Strings in the Set.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

SharedPreferences.Editor.putStringSet(String, java.util.Set), putOrderedStringSet(String, Set)

putOrderedStringSet

public static void putOrderedStringSet(java.lang.String key,
                                       java.util.Set<java.lang.String> value)

Stores a Set of Strings, preserving the order. Note that this method is heavier that the native implementation putStringSet(String, Set) (which does not reliably preserve the order of the Set). To preserve the order of the items in the Set, the Set implementation must be one that as an iterator with predictable order, such as LinkedHashSet.

Parameters:

key - The name of the preference to modify.

value - The new value for the preference.

See Also:

putStringSet(String, Set), getOrderedStringSet(String, Set)

remove

public static void remove(java.lang.String key)

Removes a preference value.

Parameters:

key - The name of the preference to remove.

See Also:

SharedPreferences.Editor.remove(String)

contains

public static boolean contains(java.lang.String key)

Checks if a value is stored for the given key.

Parameters:

key - The name of the preference to check.

Returns:

true if the storage contains this key value, false otherwise.

See Also:

SharedPreferences.contains(String)

clear

public static android.content.SharedPreferences.Editor clear()

Removed all the stored keys and values.

Returns:

the SharedPreferences.Editor for chaining. The changes have already been committed/applied through the execution of this method.

See Also:

SharedPreferences.Editor.clear()

edit

public static android.content.SharedPreferences.Editor edit()

Returns the Editor of the underlying SharedPreferences instance.

Returns:

An Editor