com.f2prateek.rx.preferences2

Interface Preference<T>

public interface Preference<T>

A preference of type T. Instances can be created from RxSharedPreferences.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Preference.Converter<T> Converts instances of T to be stored and retrieved as Strings in SharedPreferences.

Method Summary

Modifier and Type	Method and Description
<any>	asConsumer() An action which stores a new value for this preference.
<any>	asObservable() Observe changes to this preference.
T	defaultValue() The value used if none is stored.
void	delete() Delete the stored value for this preference, if any.
T	get() Retrieve the current value for this preference.
boolean	isSet() Returns true if this preference has a stored value.
java.lang.String	key() The key for which this preference will store and retrieve values.
void	set(T value) Change this preference's stored value to value.

Method Detail

key

java.lang.String key()

The key for which this preference will store and retrieve values.

defaultValue

T defaultValue()

The value used if none is stored.

get

T get()

Retrieve the current value for this preference. Returns defaultValue() if no value is set.

set

void set(T value)

Change this preference's stored value to value.

isSet

boolean isSet()

Returns true if this preference has a stored value.

delete

void delete()

Delete the stored value for this preference, if any.

asObservable

<any> asObservable()

Observe changes to this preference. The current value or defaultValue() will be emitted on first subscribe.

asConsumer

<any> asConsumer()

An action which stores a new value for this preference.