RxSPref (rxspreflib 0.2.0 API)

java.lang.Object
- com.lib.rxspreflib.RxSPref

public class RxSPref
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RxSPref`	`buildSettings()` Builds shared preference in order to access, save and remove them
`RxSPref`	`encrypt(byte[] key)` Encrypt configurations providing a key this key should have at least 128bits Remember that if you change this key the values that were written before are no longer accessible
`RxSPref`	`encrypt(java.lang.String key)` Encrypt configurations providing a key Remember that if you change this key the values that were written before are no longer accessible
`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)` Deprecated. use `provideDefaultResourceFile(int, boolean)` instead
`RxSPref`	`provideDefaultResourceFile(int resource, boolean shouldOverride)` Provide a default resource file to merge all managed settings
`<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>`	`retrieveEncrypted(java.lang.String key)` Retrieve an encrypted 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)` Writes a value to the shared preferences
`<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
`<any>`	`writeEncrypted(java.lang.String key, java.lang.String value)` Writes a value, which will be encrypted 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
    
    Returns:
    
    the RxSPref instance
  - provideDefaultFile
```
@Deprecated
public RxSPref provideDefaultFile(int resource)
```
    Deprecated. use provideDefaultResourceFile(int, boolean) instead
    
    Receives an xml file to be merged upon initialization
    
    Parameters:
    
    resource - the resource xml file
    
    Returns:
    
    instance to be initialized
  - provideDefaultResourceFile
```
public RxSPref provideDefaultResourceFile(int resource,
                                          boolean shouldOverride)
```
    Provide a default resource file to merge all managed settings
    
    Parameters:
    
    resource - the resource file
    
    shouldOverride - if every field found should override the preferences already written
    
    Returns:
    
    instance of RxSPref
  - name
```
public RxSPref name(java.lang.String preferencesName)
```
    The initializer method of the RxSPref lib
    
    Parameters:
    
    preferencesName - shared preference name
    
    Returns:
    
    the instance of RxSPref
  - encrypt
```
public RxSPref encrypt(byte[] key)
```
    Encrypt configurations providing a key this key should have at least 128bits Remember that if you change this key the values that were written before are no longer accessible
    
    Parameters:
    
    key - the key in byte[] with at least 128bits
    
    Returns:
    
    the RxSPref instance
  - encrypt
```
public RxSPref encrypt(java.lang.String key)
```
    Encrypt configurations providing a key Remember that if you change this key the values that were written before are no longer accessible
    
    Parameters:
    
    key - the key hexadecimal to encrypt
    
    Returns:
    
    the RxSPref instance
  - buildSettings
```
public RxSPref buildSettings()
```
    Builds shared preference in order to access, save and remove them
    
    Returns:
    
    the RxSPref instance
  - retrieve
```
public <any> retrieve(java.lang.String key)
```
    Retrieve a value from shared preferences
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the Observable
  - retrieveEncrypted
```
public <any> retrieveEncrypted(java.lang.String key)
```
    Retrieve an encrypted 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
    
    defaultValue - the default boolean value to save in case of error
    
    Returns:
    
    the Observable
  - retrieveAsList
```
public <T> <any> retrieveAsList(java.lang.String key)
```
    Retrieve a value from shared preferences
    
    Type Parameters:
    
    T - generic value
    
    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
  - writeEncrypted
```
public <any> writeEncrypted(java.lang.String key,
                            java.lang.String value)
```
    Writes a value, which will be encrypted 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)
```
    Writes a value to the shared preferences
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the Observable
  - write
```
public <T> <any> write(java.lang.String key,
                       java.util.List<T> value)
```
    Writes a value to the shared preferences
    
    Type Parameters:
    
    T - generic value
    
    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

Class RxSPref

Method Summary

Methods inherited from class java.lang.Object

Method Detail

init

provideDefaultFile

provideDefaultResourceFile

name

encrypt

encrypt

buildSettings

retrieve

retrieveEncrypted

retrieveAsInt

retrieveAsBoolean

retrieveAsList

retrieveAsFloat

retrieveAsLong

write

writeEncrypted

write

write

write

write

write

write

remove

removeAll