universum.studios.android.preference

Class SimpleSharedPreferencesFacade

java.lang.Object

universum.studios.android.preference.SimpleSharedPreferencesFacade

All Implemented Interfaces:

SharedPreferencesFacade

public class SimpleSharedPreferencesFacade
extends Object
implements SharedPreferencesFacade

Simple implementation of SharedPreferencesFacade which supports simple obtaining and putting of values persisted in SharedPreferences with which is facade created via SimpleSharedPreferencesFacade(SharedPreferences) constructor.

Since:

2.0

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
SimpleSharedPreferencesFacade(SharedPreferences preferences) Creates a new instance of SimpleSharedPreferencesFacade for the specified preferences.

Method Summary

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.
SharedPreferences	getPreferences() Returns the SharedPreferences that are 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(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(SharedPreferences.OnSharedPreferenceChangeListener listener) Un-registers a previously registered listener in order to not receive further any callbacks about preference changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSharedPreferencesFacade

public SimpleSharedPreferencesFacade(@NonNull
                                     SharedPreferences preferences)

Creates a new instance of SimpleSharedPreferencesFacade for the specified preferences.

Parameters:

preferences - The instance of shared preferences to hide behind the new facade.

Method Detail

getPreferences

@NonNull
public final SharedPreferences getPreferences()

Returns the SharedPreferences that are hidden behind this facade.

Returns:

The associated preferences.

See Also:

SimpleSharedPreferencesFacade(SharedPreferences)

registerOnSharedPreferenceChangeListener

public void registerOnSharedPreferenceChangeListener(@NonNull
                                                     SharedPreferences.OnSharedPreferenceChangeListener listener)

Description copied from interface: SharedPreferencesFacade

Registers a listener in order to receive a callback whenever a value of preference persisted within the SharedPreferences hidden behind this facade changes.

Specified by:

registerOnSharedPreferenceChangeListener in interface SharedPreferencesFacade

Parameters:

listener - The desired listener to be registered.

See Also:

SharedPreferencesFacade.unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener), SharedPreferences.registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener)

unregisterOnSharedPreferenceChangeListener

public void unregisterOnSharedPreferenceChangeListener(@NonNull
                                                       SharedPreferences.OnSharedPreferenceChangeListener listener)

Description copied from interface: SharedPreferencesFacade

Un-registers a previously registered listener in order to not receive further any callbacks about preference changes.

Specified by:

unregisterOnSharedPreferenceChangeListener in interface SharedPreferencesFacade

Parameters:

listener - The desired listener to be un-registered.

See Also:

SharedPreferencesFacade.registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener), SharedPreferences.unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener)

contains

public boolean contains(@NonNull
                        String key)

Description copied from interface: SharedPreferencesFacade

Checks whether the SharedPreferences hidden behind this facade contain value for the specified key or not.

Specified by:

contains in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.remove(String), SharedPreferences.contains(String)

putString

public boolean putString(@NonNull
                         String key,
                         @Nullable
                         String value)

Description copied from interface: SharedPreferencesFacade

Puts the given string value for the specified key into SharedPreferences hidden behind this facade.

Specified by:

putString in interface SharedPreferencesFacade

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

@Nullable
public String getString(@NonNull
                                  String key,
                                  @Nullable
                                  String defValue)

Description copied from interface: SharedPreferencesFacade

Retrieves the string value for the specified key from SharedPreferences hidden behind this facade.

Specified by:

getString in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.contains(String), SharedPreferences.getString(String, String)

putStringSet

public boolean putStringSet(@NonNull
                            String key,
                            @Nullable
                            Set<String> values)

Description copied from interface: SharedPreferencesFacade

Puts the given set of string values for the specified key into SharedPreferences hidden behind this facade.

Specified by:

putStringSet in interface SharedPreferencesFacade

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

@Nullable
public Set<String> getStringSet(@NonNull
                                          String key,
                                          @Nullable
                                          Set<String> defValues)

Description copied from interface: SharedPreferencesFacade

Retrieves the set of string values for the specified key from SharedPreferences hidden behind this facade.

Specified by:

getStringSet in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.contains(String), SharedPreferences.getStringSet(String, Set)

putInt

public boolean putInt(@NonNull
                      String key,
                      int value)

Description copied from interface: SharedPreferencesFacade

Puts the given integer value for the specified key into SharedPreferences hidden behind this facade.

Specified by:

putInt in interface SharedPreferencesFacade

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

public int getInt(@NonNull
                  String key,
                  int defValue)

Description copied from interface: SharedPreferencesFacade

Retrieves the integer value for the specified key from SharedPreferences hidden behind this facade.

Specified by:

getInt in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.contains(String), SharedPreferences.getInt(String, int)

putFloat

public boolean putFloat(@NonNull
                        String key,
                        float value)

Description copied from interface: SharedPreferencesFacade

Puts the given float value for the specified key into SharedPreferences hidden behind this facade.

Specified by:

putFloat in interface SharedPreferencesFacade

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

public float getFloat(@NonNull
                      String key,
                      float defValue)

Description copied from interface: SharedPreferencesFacade

Retrieves the float value for the specified key from SharedPreferences hidden behind this facade.

Specified by:

getFloat in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.contains(String), SharedPreferences.getFloat(String, float)

putLong

public boolean putLong(@NonNull
                       String key,
                       long value)

Description copied from interface: SharedPreferencesFacade

Puts the given long value for the specified key into SharedPreferences hidden behind this facade.

Specified by:

putLong in interface SharedPreferencesFacade

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

public long getLong(@NonNull
                    String key,
                    long defValue)

Description copied from interface: SharedPreferencesFacade

Retrieves the long value for the specified key from SharedPreferences hidden behind this facade.

Specified by:

getLong in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.contains(String), SharedPreferences.getLong(String, long)

putBoolean

public boolean putBoolean(@NonNull
                          String key,
                          boolean value)

Description copied from interface: SharedPreferencesFacade

Puts the given boolean value for the specified key into SharedPreferences hidden behind this facade.

Specified by:

putBoolean in interface SharedPreferencesFacade

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

public boolean getBoolean(@NonNull
                          String key,
                          boolean defValue)

Description copied from interface: SharedPreferencesFacade

Retrieves the boolean value for the specified key from SharedPreferences hidden behind this facade.

Specified by:

getBoolean in interface SharedPreferencesFacade

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:

SharedPreferencesFacade.contains(String), SharedPreferences.getBoolean(String, boolean)

remove

public boolean remove(@NonNull
                      String key)

Description copied from interface: SharedPreferencesFacade

Removes a value for the specified key from the SharedPreferences hidden behind this facade.

Specified by:

remove in interface SharedPreferencesFacade

Parameters:

key - The key for which to remove its associated value.

Returns:

True if removal has been successful, false otherwise.

See Also:

SharedPreferencesFacade.removeAll(), SharedPreferencesFacade.contains(String), SharedPreferences.edit(), SharedPreferences.Editor#remove(String)

removeAll

public int removeAll()

Description copied from interface: SharedPreferencesFacade

Removes all values from the SharedPreferences hidden behind this facade.

Specified by:

removeAll in interface SharedPreferencesFacade

Returns:

A none-negative number determining count of values that has been removed. May be 0 if there are no values persisted.

See Also:

SharedPreferencesFacade.remove(String), SharedPreferences.getAll(), SharedPreferences.edit(), SharedPreferences.Editor#remove(String)