com.f2prateek.rx.preferences2

Class RxSharedPreferences

java.lang.Object

com.f2prateek.rx.preferences2.RxSharedPreferences

public final class RxSharedPreferences
extends java.lang.Object

A factory for reactive Preference objects.

Method Summary

Modifier and Type	Method and Description
void	clear()
static RxSharedPreferences	create(android.content.SharedPreferences preferences) Create an instance of RxSharedPreferences for preferences.
Preference<java.lang.Boolean>	getBoolean(java.lang.String key) Create a boolean preference for key.
Preference<java.lang.Boolean>	getBoolean(java.lang.String key, java.lang.Boolean defaultValue) Create a boolean preference for key with a default of defaultValue.
<T extends java.lang.Enum<T>> Preference<T>	getEnum(java.lang.String key, T defaultValue, java.lang.Class<T> enumClass) Create an enum preference for key with a default of defaultValue.
Preference<java.lang.Float>	getFloat(java.lang.String key) Create a float preference for key.
Preference<java.lang.Float>	getFloat(java.lang.String key, java.lang.Float defaultValue) Create a float preference for key with a default of defaultValue.
Preference<java.lang.Integer>	getInteger(java.lang.String key) Create an integer preference for key.
Preference<java.lang.Integer>	getInteger(java.lang.String key, java.lang.Integer defaultValue) Create an integer preference for key with a default of defaultValue.
Preference<java.lang.Long>	getLong(java.lang.String key) Create a long preference for key.
Preference<java.lang.Long>	getLong(java.lang.String key, java.lang.Long defaultValue) Create a long preference for key with a default of defaultValue.
<T> Preference<T>	getObject(java.lang.String key, T defaultValue, Preference.Converter<T> converter) Create a preference for type T for key with a default of defaultValue.
Preference<java.lang.String>	getString(java.lang.String key) Create a string preference for key.
Preference<java.lang.String>	getString(java.lang.String key, java.lang.String defaultValue) Create a string preference for key with a default of defaultValue.
Preference<java.util.Set<java.lang.String>>	getStringSet(java.lang.String key) Create a string set preference for key.
Preference<java.util.Set<java.lang.String>>	getStringSet(java.lang.String key, java.util.Set<java.lang.String> defaultValue) Create a string set preference for key with a default of defaultValue.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RxSharedPreferences create(android.content.SharedPreferences preferences)

Create an instance of RxSharedPreferences for preferences.

getBoolean

public Preference<java.lang.Boolean> getBoolean(java.lang.String key)

Create a boolean preference for key. Default is false.

getBoolean

public Preference<java.lang.Boolean> getBoolean(java.lang.String key,
                                                java.lang.Boolean defaultValue)

Create a boolean preference for key with a default of defaultValue.

getEnum

public <T extends java.lang.Enum<T>> Preference<T> getEnum(java.lang.String key,
                                                           T defaultValue,
                                                           java.lang.Class<T> enumClass)

Create an enum preference for key with a default of defaultValue.

getFloat

public Preference<java.lang.Float> getFloat(java.lang.String key)

Create a float preference for key. Default is 0.

getFloat

public Preference<java.lang.Float> getFloat(java.lang.String key,
                                            java.lang.Float defaultValue)

Create a float preference for key with a default of defaultValue.

getInteger

public Preference<java.lang.Integer> getInteger(java.lang.String key)

Create an integer preference for key. Default is 0.

getInteger

public Preference<java.lang.Integer> getInteger(java.lang.String key,
                                                java.lang.Integer defaultValue)

Create an integer preference for key with a default of defaultValue.

getLong

public Preference<java.lang.Long> getLong(java.lang.String key)

Create a long preference for key. Default is 0.

getLong

public Preference<java.lang.Long> getLong(java.lang.String key,
                                          java.lang.Long defaultValue)

Create a long preference for key with a default of defaultValue.

getObject

public <T> Preference<T> getObject(java.lang.String key,
                                   T defaultValue,
                                   Preference.Converter<T> converter)

Create a preference for type T for key with a default of defaultValue.

getString

public Preference<java.lang.String> getString(java.lang.String key)

Create a string preference for key. Default is "".

getString

public Preference<java.lang.String> getString(java.lang.String key,
                                              java.lang.String defaultValue)

Create a string preference for key with a default of defaultValue.

getStringSet

public Preference<java.util.Set<java.lang.String>> getStringSet(java.lang.String key)

Create a string set preference for key. Default is an empty set. Note that returned set value will always be unmodifiable.

getStringSet

public Preference<java.util.Set<java.lang.String>> getStringSet(java.lang.String key,
                                                                java.util.Set<java.lang.String> defaultValue)

Create a string set preference for key with a default of defaultValue.

clear

public void clear()