SharedPreferencesFacade (library API)

All Known Implementing Classes:

PreferencesManager, SimpleSharedPreferencesFacade
```
public interface SharedPreferencesFacade
```
Interface that specifies a layer which may be used to hide a concrete implementation of SharedPreferences and to simplify putting and obtaining of values for such preferences implementation.

Author:

Martin Albedinsky

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`contains(String key)` Checks whether the `SharedPreferences` hidden behind this facade contain value for the specified `key` or not.
`boolean`	`getBoolean(String key, boolean defValue)` Retrieves the boolean value for the specified `key` from `SharedPreferences` hidden behind this facade.
`float`	`getFloat(String key, float defValue)` Retrieves the float value for the specified `key` from `SharedPreferences` hidden behind this facade.
`int`	`getInt(String key, int defValue)` Retrieves the integer value for the specified `key` from `SharedPreferences` hidden behind this facade.
`long`	`getLong(String key, long defValue)` Retrieves the long value for the specified `key` from `SharedPreferences` hidden behind this facade.
`String`	`getString(String key, String defValue)` Retrieves the string value for the specified `key` from `SharedPreferences` hidden behind this facade.
`Set<String>`	`getStringSet(String key, Set<String> defValues)` Retrieves the set of string values for the specified `key` from `SharedPreferences` hidden behind this facade.
`boolean`	`putBoolean(String key, boolean value)` Puts the given boolean `value` for the specified `key` into `SharedPreferences` hidden behind this facade.
`boolean`	`putFloat(String key, float value)` Puts the given float `value` for the specified `key` into `SharedPreferences` hidden behind this facade.
`boolean`	`putInt(String key, int value)` Puts the given integer `value` for the specified `key` into `SharedPreferences` hidden behind this facade.
`boolean`	`putLong(String key, long value)` Puts the given long `value` for the specified `key` into `SharedPreferences` hidden behind this facade.
`boolean`	`putString(String key, String value)` Puts the given string `value` for the specified `key` into `SharedPreferences` hidden behind this facade.
`boolean`	`putStringSet(String key, Set<String> values)` Puts the given set of string `values` for the specified `key` into `SharedPreferences` hidden behind this facade.
`void`	`registerOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener listener)` Registers a listener in order to receive a callback whenever a value of preference persisted within the `SharedPreferences` hidden behind this facade changes.
`boolean`	`remove(String key)` Removes a value for the specified `key` from the `SharedPreferences` hidden behind this facade.
`int`	`removeAll()` Removes all values from the `SharedPreferences` hidden behind this facade.
`void`	`unregisterOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener listener)` Un-registers a previously registered listener in order to not receive further any callbacks about preference changes.

- Method Detail
  - registerOnSharedPreferenceChangeListener
```
void registerOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener listener)
```
    Registers a listener in order to receive a callback whenever a value of preference persisted within the SharedPreferences hidden behind this facade changes.
    
    Parameters:
    
    listener - The desired listener to be registered.
    
    See Also:
    
    unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener), SharedPreferences.registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener)
  - unregisterOnSharedPreferenceChangeListener
```
void unregisterOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener listener)
```
    Un-registers a previously registered listener in order to not receive further any callbacks about preference changes.
    
    Parameters:
    
    listener - The desired listener to be un-registered.
    
    See Also:
    
    registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener), SharedPreferences.unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener)
  - contains
```
boolean contains(String key)
```
    Checks whether the SharedPreferences hidden behind this facade contain value for the specified key or not.
    
    Parameters:
    
    key - The key of which value's presence to check.
    
    Returns:
    
    True if there is value contained for the specified key, false otherwise.
    
    See Also:
    
    remove(String), SharedPreferences.contains(String)
  - putString
```
boolean putString(String key,
                  String value)
```
    Puts the given string value for the specified key into SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to put the value into preferences.
    
    value - The desired value to put into preferences.
    
    Returns:
    
    True if put has been successful, false otherwise.
    
    See Also:
    
    SharedPreferences.edit(), SharedPreferences.Editor#putString(String, String)
  - getString
```
String getString(String key,
                 String defValue)
```
    Retrieves the string value for the specified key from SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to retrieve its associated value.
    
    defValue - Default value to be returned in case when there is no value persisted for the specified key.
    
    Returns:
    
    Either persisted or default string value.
    
    See Also:
    
    contains(String), SharedPreferences.getString(String, String)
  - putStringSet
```
boolean putStringSet(String key,
                     Set<String> values)
```
    Puts the given set of string values for the specified key into SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to put the values into preferences.
    
    values - The desired values to put into preferences.
    
    Returns:
    
    True if put has been successful, false otherwise.
    
    See Also:
    
    SharedPreferences.edit(), SharedPreferences.Editor#putStringSet(String, Set)
  - getStringSet
```
Set<String> getStringSet(String key,
                         Set<String> defValues)
```
    Retrieves the set of string values for the specified key from SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to retrieve its associated values.
    
    defValues - Default values to be returned in case when there are no values persisted for the specified key.
    
    Returns:
    
    Either persisted or default string values.
    
    See Also:
    
    contains(String), SharedPreferences.getStringSet(String, Set)
  - putInt
```
boolean putInt(String key,
               int value)
```
    Puts the given integer value for the specified key into SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to put the value into preferences.
    
    value - The desired value to put into preferences.
    
    Returns:
    
    True if put has been successful, false otherwise.
    
    See Also:
    
    SharedPreferences.edit(), SharedPreferences.Editor#putInt(String, int)
  - getInt
```
int getInt(String key,
           int defValue)
```
    Retrieves the integer value for the specified key from SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to retrieve its associated value.
    
    defValue - Default value to be returned in case when there is no value persisted for the specified key.
    
    Returns:
    
    Either persisted or default integer value.
    
    See Also:
    
    contains(String), SharedPreferences.getInt(String, int)
  - putFloat
```
boolean putFloat(String key,
                 float value)
```
    Puts the given float value for the specified key into SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to put the value into preferences.
    
    value - The desired value to put into preferences.
    
    Returns:
    
    True if put has been successful, false otherwise.
    
    See Also:
    
    SharedPreferences.edit(), SharedPreferences.Editor#putFloat(String, float)
  - getFloat
```
float getFloat(String key,
               float defValue)
```
    Retrieves the float value for the specified key from SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to retrieve its associated value.
    
    defValue - Default value to be returned in case when there is no value persisted for the specified key.
    
    Returns:
    
    Either persisted or default float value.
    
    See Also:
    
    contains(String), SharedPreferences.getFloat(String, float)
  - putLong
```
boolean putLong(String key,
                long value)
```
    Puts the given long value for the specified key into SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to put the value into preferences.
    
    value - The desired value to put into preferences.
    
    Returns:
    
    True if put has been successful, false otherwise.
    
    See Also:
    
    SharedPreferences.edit(), SharedPreferences.Editor#putLong(String, long)
  - getLong
```
long getLong(String key,
             long defValue)
```
    Retrieves the long value for the specified key from SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to retrieve its associated value.
    
    defValue - Default value to be returned in case when there is no value persisted for the specified key.
    
    Returns:
    
    Either persisted or default long value.
    
    See Also:
    
    contains(String), SharedPreferences.getLong(String, long)
  - putBoolean
```
boolean putBoolean(String key,
                   boolean value)
```
    Puts the given boolean value for the specified key into SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to put the value into preferences.
    
    value - The desired value to put into preferences.
    
    Returns:
    
    True if put has been successful, false otherwise.
    
    See Also:
    
    SharedPreferences.edit(), SharedPreferences.Editor#putBoolean(String, boolean)
  - getBoolean
```
boolean getBoolean(String key,
                   boolean defValue)
```
    Retrieves the boolean value for the specified key from SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to retrieve its associated value.
    
    defValue - Default value to be returned in case when there is no value persisted for the specified key.
    
    Returns:
    
    Either persisted or default boolean value.
    
    See Also:
    
    contains(String), SharedPreferences.getBoolean(String, boolean)
  - remove
```
boolean remove(String key)
```
    Removes a value for the specified key from the SharedPreferences hidden behind this facade.
    
    Parameters:
    
    key - The key for which to remove its associated value.
    
    Returns:
    
    True if removal has been successful, false otherwise.
    
    See Also:
    
    removeAll(), contains(String), SharedPreferences.edit(), SharedPreferences.Editor#remove(String)
  - removeAll
```
int removeAll()
```
    Removes all values from the SharedPreferences hidden behind this facade.
    
    Returns:
    
    A none-negative number determining count of values that has been removed. May be 0 if there are no values persisted.
    
    See Also:
    
    remove(String), SharedPreferences.getAll(), SharedPreferences.edit(), SharedPreferences.Editor#remove(String)

Interface SharedPreferencesFacade

Method Summary

Method Detail

registerOnSharedPreferenceChangeListener

unregisterOnSharedPreferenceChangeListener

contains

putString

getString

putStringSet

getStringSet

putInt

getInt

putFloat

getFloat

putLong

getLong

putBoolean

getBoolean

remove

removeAll