universum.studios.android.preference

Class SharedPreferencesWrapper

java.lang.Object

universum.studios.android.preference.SharedPreferencesWrapper

All Implemented Interfaces:

SharedPreferences

public class SharedPreferencesWrapper
extends Object
implements SharedPreferences

A SharedPreferences implementation which may be used to wrap an instance of SharedPreferences. This wrapper class simply delegates all its calls to the wrapped preferences instance.

Since:

2.0

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from interface android.content.SharedPreferences

SharedPreferences.Editor, SharedPreferences.OnSharedPreferenceChangeListener

Constructor Summary

Constructors

Constructor and Description
SharedPreferencesWrapper(SharedPreferences preferences) Creates a new instance of SharedPreferencesWrapper in order to wrap the given preferences instance.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key)
SharedPreferences.Editor	edit()
Map<String,?>	getAll()
boolean	getBoolean(String key, boolean defValue)
float	getFloat(String key, float defValue)
int	getInt(String key, int defValue)
long	getLong(String key, long defValue)
String	getString(String key, String defValue)
Set<String>	getStringSet(String key, Set<String> defValues)
SharedPreferences	getWrappedPreferences() Returns the wrapped SharedPreferences instance.
void	registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)
void	unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedPreferencesWrapper

public SharedPreferencesWrapper(@NonNull
                                SharedPreferences preferences)

Creates a new instance of SharedPreferencesWrapper in order to wrap the given preferences instance.

Parameters:

preferences - The shared preferences to be wrapped.

Method Detail

getWrappedPreferences

@NonNull
public final SharedPreferences getWrappedPreferences()

Returns the wrapped SharedPreferences instance.

Returns:

Instance of SharedPreferences that are wrapped by this preferences wrapper.

registerOnSharedPreferenceChangeListener

public void registerOnSharedPreferenceChangeListener(@NonNull
                                                     SharedPreferences.OnSharedPreferenceChangeListener listener)

Specified by:

registerOnSharedPreferenceChangeListener in interface SharedPreferences

unregisterOnSharedPreferenceChangeListener

public void unregisterOnSharedPreferenceChangeListener(@NonNull
                                                       SharedPreferences.OnSharedPreferenceChangeListener listener)

Specified by:

unregisterOnSharedPreferenceChangeListener in interface SharedPreferences

getAll

public Map<String,?> getAll()

Specified by:

getAll in interface SharedPreferences

contains

public boolean contains(@NonNull
                        String key)

Specified by:

contains in interface SharedPreferences

getString

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

Specified by:

getString in interface SharedPreferences

getStringSet

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

Specified by:

getStringSet in interface SharedPreferences

getInt

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

Specified by:

getInt in interface SharedPreferences

getLong

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

Specified by:

getLong in interface SharedPreferences

getFloat

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

Specified by:

getFloat in interface SharedPreferences

getBoolean

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

Specified by:

getBoolean in interface SharedPreferences

edit

@NonNull
public SharedPreferences.Editor edit()

Specified by:

edit in interface SharedPreferences