BasePreferences (androTools 1.1.1 API)

java.lang.Object
- de.dimensionv.android.androtools.preferences.BasePreferences

All Implemented Interfaces:

SharedPreferences, SharedPreferences.Editor, Initializer, MemoryTrimmer
```
public abstract class BasePreferences
extends Object
implements SharedPreferences, SharedPreferences.Editor, Initializer, MemoryTrimmer
```
Base-class for SharedPreferences handling.

This base-class implements the SharedPreferences and SharedPreferences.Editor interfaces directly for a more convenient access and easier handling.

Since this class is using caching mechanisms for certain aspects, it also implements the MemoryTrimmer interface. In order to be properly available after a trim memory event, the Initializer interface is implemented as well, doing necessary initialization.

Furthermore, this class has support for easily storing string-sets into the properties-file, a feature that is only available from API-Level 11 (Honeycomb) and later. If the appropriate API-Level is detected during runtime, the "native" method for storing string sets will be used, otherwise the "support-implementation" introduced by this class will be used.
In order to be backwards compatible for devices that get updated from an API-Level below 11 to an API-Level of 11 or above, this implementation can detect that previously the old routines were used, and will silently make a transition to the new native routines.

Since:

API 1.0.0

Nested Class Summary
- Nested classes/interfaces inherited from interface android.content.SharedPreferences
  SharedPreferences.Editor, SharedPreferences.OnSharedPreferenceChangeListener

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`cachePath` The application's cachePath.
`protected Context`	`context` The application context
`protected SharedPreferences.Editor`	`editor` An editor object used internally to write the preferences and finally commit/apply them.
`protected SharedPreferences`	`settings` The actual `SharedPreferences` object that is used internally.

Constructor Summary

Constructors
Constructor and Description
`BasePreferences(Context context)` Creates and initializes `BasePreferences` object with the given `Context`.
`BasePreferences(Context context, String fileName)` Creates and initializes `BasePreferences` object with the given `Context`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`apply()`
`SharedPreferences.Editor`	`clear()`
`boolean`	`commit()`
`boolean`	`contains(String key)`
`SharedPreferences.Editor`	`edit()`
`Map<String,?>`	`getAll()`
`boolean`	`getBoolean(String key, boolean defValue)`
`static String`	`getCachePath()` Returns the application's cache-path
`abstract String`	`getFileName()` Returns the filename of the `SharedPreferences` file used by this `BasePreferences` object.
`float`	`getFloat(String key, float defValue)`
`protected String`	`getHash(String value)` Aquires the hash for the given `value`.
`int`	`getInt(String key, int defValue)`
`protected HashMap<String,String>`	`getKeyMap()` Returns the keyMap cache.
`long`	`getLong(String key, long defValue)`
`String`	`getString(String key, String defValue)`
`Set<String>`	`getStringSet(String key, Set<String> defValues)`
`void`	`onForceTrim()` Strict release of all not strictly necessary memory resources.
`void`	`onInitialize(Context context, TrimState trimState)` This method triggers the initialization of its implementer.
`void`	`onTrim()` Relaxed release of memory
`SharedPreferences.Editor`	`putBoolean(String key, boolean value)`
`SharedPreferences.Editor`	`putFloat(String key, float value)`
`SharedPreferences.Editor`	`putInt(String key, int value)`
`SharedPreferences.Editor`	`putLong(String key, long value)`
`SharedPreferences.Editor`	`putString(String key, String value)`
`SharedPreferences.Editor`	`putStringSet(String key, Set<String> values)`
`void`	`registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)`
`SharedPreferences.Editor`	`remove(String key)`
`void`	`unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - settings
```
protected SharedPreferences settings
```
    The actual SharedPreferences object that is used internally.
    
    Since:
    
    API 1.0.0
  - editor
```
protected SharedPreferences.Editor editor
```
    An editor object used internally to write the preferences and finally commit/apply them. It needs to be aquired through getEditor(), and will be released by calling apply() or commit().
    
    Since:
    
    Class 1.0, API 1.0.0
  - cachePath
```
protected static String cachePath
```
    The application's cachePath.
    
    Since:
    
    Class 1.0, API 1.0.0
    
    See Also:
    getCachePath()
  - context
```
protected Context context
```
    The application context
    
    Since:
    
    Class 1.0, API 1.0.0
- Constructor Detail
  - BasePreferences
```
public BasePreferences(Context context)
```
    Creates and initializes BasePreferences object with the given Context.
    For the setting of the required preferences-file's file name the abstract method getFileName()
    
    Parameters:
    context - The application context
    Since:
    
    Class 1.0, API 1.0.0
  - BasePreferences
```
public BasePreferences(Context context,
               String fileName)
```
    Creates and initializes BasePreferences object with the given Context.
    
    Parameters:
    context - The application context
    fileName - The name of the preference file.
    Since:
    
    Class 1.0, API 1.0.0
- Method Detail
  - getCachePath
```
public static String getCachePath()
```
    Returns the application's cache-path
    
    Returns:
    the cachePath
    Since:
    
    Class 1.0, API 1.0.0
  - getFileName
```
public abstract String getFileName()
```
    Returns the filename of the SharedPreferences file used by this BasePreferences object.
    
    Returns:
    The filename
    Since:
    
    Class 1.0, API 1.0.0
  - getHash
```
protected String getHash(String value)
```
    Aquires the hash for the given value.
    
    This method checks the keyMap first if the value has already been hashed before, and only if that's not the case, attempts to compute a new hash of the value.
    If possible, the SHA1-Algorithm will be used for hashing. Should that fail, a the simple standard String.hashCode() method will be used.
    
    In case the value has been hashed before, it will be taken from the in-memory cache.
    
    Parameters:
    value - The value to be hashed.
    
    Returns:
    The hash-value as a hexadecimal String.
    Since:
    
    Class 1.0, API 1.0.0
  - getKeyMap
```
protected HashMap<String,String> getKeyMap()
```
    Returns the keyMap cache.
    
    In case it wasn't instantiated, yet, this method will take care of that.
    
    Returns:
    The keyMap cache
    Since:
    
    Class 1.0, API 1.0.0
  - onTrim
```
public void onTrim()
```
    Description copied from interface: MemoryTrimmer
    
    Relaxed release of memory
    
    This is the method that should be called from Application.ActivityLifecycleCallbacks#onTrimMemory(int) on a level like Application.ActivityLifecycleCallbacks#TRIM_MEMORY_BACKGROUND.
    Though this is not mandatory, and this method can be run at any level, it is recommended to have this method run at a lower level than the MemoryTrimmer.onForceTrim() method.
    
    Specified by:
    
    onTrim in interface MemoryTrimmer
  - onForceTrim
```
public void onForceTrim()
```
    Description copied from interface: MemoryTrimmer
    
    Strict release of all not strictly necessary memory resources.
    
    The call to this method should also ensure that all resources that would be freed by MemoryTrimmer.onTrim() are definitely freed.
    
    This is the method that should be called from Application.ActivityLifecycleCallbacks#onLowMemory() or preferrably from Application.ActivityLifecycleCallbacks#onTrimMemory(int) with the Application.ActivityLifecycleCallbacks#TRIM_MEMORY_COMPLETE level.
    
    Specified by:
    
    onForceTrim in interface MemoryTrimmer
  - onInitialize
```
public void onInitialize(Context context,
                TrimState trimState)
```
    Description copied from interface: Initializer
    
    This method triggers the initialization of its implementer.
    
    Specified by:
    
    onInitialize in interface Initializer
    
    Parameters:
    context - The Context-object, because it might be necessary for the initialization.
    trimState - The current of the app, which should be the same TrimState of all Initializers.
  - getAll
```
public Map<String,?> getAll()
```
    Specified by:
    
    getAll in interface SharedPreferences
  - getString
```
public String getString(String key,
               String defValue)
```
    Specified by:
    
    getString in interface SharedPreferences
  - getStringSet
```
public Set<String> getStringSet(String key,
                       Set<String> defValues)
```
    Specified by:
    
    getStringSet in interface SharedPreferences
  - getInt
```
public int getInt(String key,
         int defValue)
```
    Specified by:
    
    getInt in interface SharedPreferences
  - getLong
```
public long getLong(String key,
           long defValue)
```
    Specified by:
    
    getLong in interface SharedPreferences
  - getFloat
```
public float getFloat(String key,
             float defValue)
```
    Specified by:
    
    getFloat in interface SharedPreferences
  - getBoolean
```
public boolean getBoolean(String key,
                 boolean defValue)
```
    Specified by:
    
    getBoolean in interface SharedPreferences
  - contains
```
public boolean contains(String key)
```
    Specified by:
    
    contains in interface SharedPreferences
  - edit
```
public SharedPreferences.Editor edit()
```
    Specified by:
    
    edit in interface SharedPreferences
  - registerOnSharedPreferenceChangeListener
```
public void registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)
```
    Specified by:
    
    registerOnSharedPreferenceChangeListener in interface SharedPreferences
  - unregisterOnSharedPreferenceChangeListener
```
public void unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)
```
    Specified by:
    
    unregisterOnSharedPreferenceChangeListener in interface SharedPreferences
  - putString
```
public SharedPreferences.Editor putString(String key,
                                 String value)
```
    Specified by:
    
    putString in interface SharedPreferences.Editor
  - putStringSet
```
public SharedPreferences.Editor putStringSet(String key,
                                    Set<String> values)
```
    Specified by:
    
    putStringSet in interface SharedPreferences.Editor
  - putInt
```
public SharedPreferences.Editor putInt(String key,
                              int value)
```
    Specified by:
    
    putInt in interface SharedPreferences.Editor
  - putLong
```
public SharedPreferences.Editor putLong(String key,
                               long value)
```
    Specified by:
    
    putLong in interface SharedPreferences.Editor
  - putFloat
```
public SharedPreferences.Editor putFloat(String key,
                                float value)
```
    Specified by:
    
    putFloat in interface SharedPreferences.Editor
  - putBoolean
```
public SharedPreferences.Editor putBoolean(String key,
                                  boolean value)
```
    Specified by:
    
    putBoolean in interface SharedPreferences.Editor
  - remove
```
public SharedPreferences.Editor remove(String key)
```
    Specified by:
    
    remove in interface SharedPreferences.Editor
  - clear
```
public SharedPreferences.Editor clear()
```
    Specified by:
    
    clear in interface SharedPreferences.Editor
  - commit
```
public boolean commit()
```
    Specified by:
    
    commit in interface SharedPreferences.Editor
  - apply
```
public void apply()
```
    Specified by:
    
    apply in interface SharedPreferences.Editor

Class BasePreferences

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

settings

editor

cachePath

context

Constructor Detail

BasePreferences

BasePreferences

Method Detail

getCachePath

getFileName

getHash

getKeyMap

onTrim

onForceTrim

onInitialize

getAll

getString

getStringSet

getInt

getLong

getFloat

getBoolean

contains

edit

registerOnSharedPreferenceChangeListener

unregisterOnSharedPreferenceChangeListener

putString

putStringSet

putInt

putLong

putFloat

putBoolean

remove

clear

commit

apply