com.lib.rxspreflib

Class RxSPref

java.lang.Object

com.lib.rxspreflib.RxSPref

public class RxSPref
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
RxSPref	buildSettings() Builds shared preference in order to access, save and remove them
static RxSPref	init(android.content.Context context) This should be called in application onCreate
RxSPref	name(java.lang.String preferencesName) The initializer method of the RxSPref lib
RxSPref	provideDefaultFile(int resource) Receives an xml file to be merged upon initialization
<any>	remove(java.lang.String key) Remove a setting
<any>	removeAll(java.lang.String key) Remove all settings
<any>	retrieve(java.lang.String key) Retrieve a value from shared preferences
<any>	retrieveAsBoolean(java.lang.String key, boolean defaultValue) Retrieve a value from shared preferences
<any>	retrieveAsFloat(java.lang.String key) Retrieve a value from shared preferences
<any>	retrieveAsInt(java.lang.String key) Retrieve a value from shared preferences
<T> <any>	retrieveAsList(java.lang.String key) Retrieve a value from shared preferences
<any>	retrieveAsLong(java.lang.String key) Retrieve a value from shared preferences
<any>	write(java.lang.String key, boolean value) Writes a value to the shared preferences
<any>	write(java.lang.String key, float value) Writes a value to the shared preferences
<any>	write(java.lang.String key, int value) Writes a value to the shared preferences
<T> <any>	write(java.lang.String key, java.util.List<T> value) Writes a value to the shared preferences
<any>	write(java.lang.String key, long value)
<any>	write(java.lang.String key, java.util.Set<java.lang.String> value) Writes a value to the shared preferences
<any>	write(java.lang.String key, java.lang.String value) Writes a value to the shared preferences

Methods inherited from class java.lang.Object

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

Method Detail

init

public static RxSPref init(android.content.Context context)

This should be called in application onCreate

Parameters:

context - the application context

provideDefaultFile

public RxSPref provideDefaultFile(int resource)

Receives an xml file to be merged upon initialization

Parameters:

resource - the resource xml file

Returns:

instance to be initialized

name

public RxSPref name(java.lang.String preferencesName)

The initializer method of the RxSPref lib

Parameters:

preferencesName - shared preference name

Returns:

the instance of SPref

buildSettings

public RxSPref buildSettings()

Builds shared preference in order to access, save and remove them

retrieve

public <any> retrieve(java.lang.String key)

Retrieve a value from shared preferences

Parameters:

key - the key

Returns:

the Observable

retrieveAsInt

public <any> retrieveAsInt(java.lang.String key)

Retrieve a value from shared preferences

Parameters:

key - the key

Returns:

the Observable

retrieveAsBoolean

public <any> retrieveAsBoolean(java.lang.String key,
                               boolean defaultValue)

Retrieve a value from shared preferences

Parameters:

key - the key

Returns:

the Observable

retrieveAsList

public <T> <any> retrieveAsList(java.lang.String key)

Retrieve a value from shared preferences

Parameters:

key - the key

Returns:

the Observable

retrieveAsFloat

public <any> retrieveAsFloat(java.lang.String key)

Retrieve a value from shared preferences

Parameters:

key - the key

Returns:

the Observable

retrieveAsLong

public <any> retrieveAsLong(java.lang.String key)

Retrieve a value from shared preferences

Parameters:

key - the key

Returns:

the Observable

write

public <any> write(java.lang.String key,
                   java.lang.String value)

Writes a value to the shared preferences

Parameters:

key - the key

value - the value

Returns:

the Observable

write

public <any> write(java.lang.String key,
                   int value)

Writes a value to the shared preferences

Parameters:

key - the key

value - the value

Returns:

the Observable

write

public <any> write(java.lang.String key,
                   boolean value)

Writes a value to the shared preferences

Parameters:

key - the key

value - the value

Returns:

the Observable

write

public <any> write(java.lang.String key,
                   float value)

Writes a value to the shared preferences

Parameters:

key - the key

value - the value

Returns:

the Observable

write

public <any> write(java.lang.String key,
                   long value)

write

public <T> <any> write(java.lang.String key,
                       java.util.List<T> value)

Writes a value to the shared preferences

Parameters:

key - the key

value - the value

Returns:

the Observable

write

public <any> write(java.lang.String key,
                   java.util.Set<java.lang.String> value)

Writes a value to the shared preferences

Parameters:

key - the key

value - the value

Returns:

the Observable

remove

public <any> remove(java.lang.String key)

Remove a setting

Parameters:

key - the setting key

Returns:

the observable

removeAll

public <any> removeAll(java.lang.String key)

Remove all settings

Parameters:

key - the setting key

Returns:

the observable