Skip navigation links
Android Preferences 1.0.1 Documentation
A B C D E F G I K L M O P R S U 

A

ArrayPreference<T> - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) an array preference value within SharedPreferences.
ArrayPreference(String, T) - Constructor for class universum.studios.android.preference.ArrayPreference
Creates a new instance of universum.studios.android.preference.ArrayPreference.
ArrayPreference(int, T) - Constructor for class universum.studios.android.preference.ArrayPreference
Creates a new instance of universum.studios.android.preference.ArrayPreference.
attachKey(Resources) - Method in class universum.studios.android.preference.SharedPreference
Attaches the key for this preference from the given resources using the current key's resource id specified via SharedPreference.SharedPreference(int, Object).

B

BooleanPreference - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) a Boolean preference value within SharedPreferences.
BooleanPreference(String, Boolean) - Constructor for class universum.studios.android.preference.BooleanPreference
Creates a new instance of BooleanPreference.
BooleanPreference(int, Boolean) - Constructor for class universum.studios.android.preference.BooleanPreference
Creates a new instance of BooleanPreference.

C

contains(String) - Method in class universum.studios.android.preference.PreferencesManager
Checks whether there is contained some value for the specified key in the share preferences.
containsPreference(SharedPreference) - Method in class universum.studios.android.preference.PreferencesManager
Checks whether value of the given preference is contained within the shared preferences.
createOnChangeListener(SharedPreference.PreferenceChangeCallback<Type>) - Method in class universum.studios.android.preference.SharedPreference
Creates new instance of SharedPreferences.OnSharedPreferenceChangeListener which can be used to listen on changes provided up on the value of this preference within shared preferences.

D

DEBUG_LOG_ENABLED - Static variable in class universum.studios.android.preference.PreferencesConfig
Flag indicating whether the debug output for the Preferences library trough log-cat is enabled or not.
defaultSharedPreferencesName(Context) - Static method in class universum.studios.android.preference.PreferencesManager
Creates a default name for shared preferences (like the one created by PreferenceManager).

E

EnumPreference<E extends Enum> - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) an Enum preference value within SharedPreferences.
EnumPreference(String, E) - Constructor for class universum.studios.android.preference.EnumPreference
Creates a new instance of EnumPreference.
EnumPreference(int, E) - Constructor for class universum.studios.android.preference.EnumPreference
Creates a new instance of EnumPreference.

F

FloatPreference - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) a Float preference value within SharedPreferences.
FloatPreference(String, Float) - Constructor for class universum.studios.android.preference.FloatPreference
Creates a new instance of FloatPreference.
FloatPreference(int, Float) - Constructor for class universum.studios.android.preference.FloatPreference
Creates a new instance of FloatPreference.

G

getBoolean(String, boolean) - Method in class universum.studios.android.preference.PreferencesManager
Returns the boolean value mapped in the shared preferences under the given key.
getDefaultValue() - Method in class universum.studios.android.preference.SharedPreference
Returns the default value of this preference.
getFloat(String, float) - Method in class universum.studios.android.preference.PreferencesManager
Returns the float value mapped in the shared preferences under the given key.
getFromPreferences(SharedPreferences, String, Object) - Static method in class universum.studios.android.preference.ArrayPreference
Returns an array mapped in the given shared preferences under the specified key.
getFromPreferences(SharedPreferences, String, List<T>) - Static method in class universum.studios.android.preference.ListPreference
Returns a List mapped in the given shared preferences under the specified key.
getInt(String, int) - Method in class universum.studios.android.preference.PreferencesManager
Returns the int value mapped in the shared preferences under the given key.
getKey() - Method in class universum.studios.android.preference.SharedPreference
Returns the key of this preference.
getKeyRes() - Method in class universum.studios.android.preference.SharedPreference
Return the resource id of the key of this preference.
getLong(String, long) - Method in class universum.studios.android.preference.PreferencesManager
Returns the long value mapped in the shared preferences under the given key.
getMode() - Method in class universum.studios.android.preference.PreferencesManager
Returns the actual file creation mode for shared preferences.
getPreference(SharedPreference<Type>) - Method in class universum.studios.android.preference.PreferencesManager
Obtains the value of the given preference from shared preferences.
getSharedPreferences() - Method in class universum.studios.android.preference.PreferencesManager
Returns the instance of SharedPreferences depends on the current file creation mode and preferences name.
getSharedPreferencesName() - Method in class universum.studios.android.preference.PreferencesManager
Returns the actual name for shared preferences.
getString(String, String) - Method in class universum.studios.android.preference.PreferencesManager
Returns the String value mapped in the shared preferences under the given key.
getValue() - Method in class universum.studios.android.preference.SharedPreference
Returns the value, which is currently being hold by this preference object.

I

IntegerPreference - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) an Integer preference value within SharedPreferences.
IntegerPreference(String, Integer) - Constructor for class universum.studios.android.preference.IntegerPreference
Creates a new instance of IntegerPreference.
IntegerPreference(int, Integer) - Constructor for class universum.studios.android.preference.IntegerPreference
Creates a new instance of IntegerPreference.
isCachingEnabled() - Method in class universum.studios.android.preference.PreferencesManager
Returns flag indicating whether the caching of SharedPreference's values is enabled or not.

K

key(int) - Method in class universum.studios.android.preference.PreferencesManager
Returns a string key for the specified resId.

L

ListPreference<T> - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) a List preference value within SharedPreferences.
ListPreference(String, Class<T>, List<T>) - Constructor for class universum.studios.android.preference.ListPreference
Creates a new instance of universum.studios.android.preference.ListPreference.
ListPreference(int, Class<T>, List<T>) - Constructor for class universum.studios.android.preference.ListPreference
Creates a new instance of universum.studios.android.preference.ListPreference.
LOG_ENABLED - Static variable in class universum.studios.android.preference.PreferencesConfig
Flag indicating whether the verbose output for the Preferences library trough log-cat is enabled or not.
LongPreference - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) a Long preference value within SharedPreferences.
LongPreference(String, Long) - Constructor for class universum.studios.android.preference.LongPreference
Creates a new instance of LongPreference.
LongPreference(int, Long) - Constructor for class universum.studios.android.preference.LongPreference
Creates a new instance of LongPreference.

M

mContext - Variable in class universum.studios.android.preference.PreferencesManager
Application context used to access preferences.
MODE_APPEND - Static variable in class universum.studios.android.preference.PreferencesManager
Wrapped mode: Context.MODE_APPEND
MODE_ENABLE_WRITE_AHEAD_LOGGING - Static variable in class universum.studios.android.preference.PreferencesManager
Wrapped mode: Context.MODE_ENABLE_WRITE_AHEAD_LOGGING
MODE_MULTI_PROCESS - Static variable in class universum.studios.android.preference.PreferencesManager
Wrapped mode: Context.MODE_MULTI_PROCESS
MODE_PRIVATE - Static variable in class universum.studios.android.preference.PreferencesManager
Wrapped mode: Context.MODE_PRIVATE

O

onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.ArrayPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.BooleanPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.EnumPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.FloatPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.IntegerPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.ListPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.LongPreference
 
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.SharedPreference
Invoked to retrieve the actual value of this preference from the given shared preferences.
onGetFromPreferences(SharedPreferences) - Method in class universum.studios.android.preference.StringPreference
 
onPreferenceChanged(SharedPreference<PreferenceType>) - Method in interface universum.studios.android.preference.SharedPreference.PreferenceChangeCallback
Invoked whenever a value of the specified preference has been changed.
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.ArrayPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.BooleanPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.EnumPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.FloatPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.IntegerPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.ListPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.LongPreference
 
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.SharedPreference
Invoked to save the actual value into the given shared preferences.
onPutIntoPreferences(SharedPreferences) - Method in class universum.studios.android.preference.StringPreference
 

P

PreferencesConfig - Class in universum.studios.android.preference
Configuration options for the Preferences library.
PreferencesManager - Class in universum.studios.android.preference
Manager that may be used to simplify management (storing + obtaining) of values presented within a SharedPreferences of an Android application.
PreferencesManager(Context) - Constructor for class universum.studios.android.preference.PreferencesManager
Same as PreferencesManager.PreferencesManager(Context, String) with default name for preferences (like the one provided by Android framework).
PreferencesManager(Context, String) - Constructor for class universum.studios.android.preference.PreferencesManager
Same as PreferencesManager.PreferencesManager(Context, String, int) with Context.MODE_PRIVATE creation mode.
PreferencesManager(Context, String, int) - Constructor for class universum.studios.android.preference.PreferencesManager
Creates a new instance of PreferencesManager with the given shared preferences name and preferences file creation mode.
PreferencesManager.Mode - Annotation Type in universum.studios.android.preference
Defines an annotation for determining set of allowed flags for PreferencesManager.setMode(int) method.
putBoolean(String, boolean) - Method in class universum.studios.android.preference.PreferencesManager
Saves the given boolean value into shared preferences.
putFloat(String, float) - Method in class universum.studios.android.preference.PreferencesManager
Saves the given float value into shared preferences.
putInt(String, int) - Method in class universum.studios.android.preference.PreferencesManager
Saves the given int value into shared preferences.
putIntoPreferences(SharedPreferences, String, Object) - Static method in class universum.studios.android.preference.ArrayPreference
Saves the given array into the given shared preferences.
putIntoPreferences(SharedPreferences, String, List<T>, Class<T>) - Static method in class universum.studios.android.preference.ListPreference
Saves the given list into the given shared preferences.
putLong(String, long) - Method in class universum.studios.android.preference.PreferencesManager
Saves the given long value into shared preferences.
putPreference(SharedPreference<Type>, Type) - Method in class universum.studios.android.preference.PreferencesManager
Saves the given value using the specified preference into shared preferences.
putString(String, String) - Method in class universum.studios.android.preference.PreferencesManager
Saves the given String value into shared preferences.

R

registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener) - Method in class universum.studios.android.preference.PreferencesManager
Same as SharedPreferences.registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener).
remove(String) - Method in class universum.studios.android.preference.PreferencesManager
Removes current value of a preference with the specified key from the shared preferences.
removePreference(SharedPreference) - Method in class universum.studios.android.preference.PreferencesManager
Removes current value of the given preference from the shared preferences.
retrieve(SharedPreferences) - Method in class universum.studios.android.preference.SharedPreference
Retrieves the current value of this preference from the given shared preferences.

S

save(SharedPreferences) - Method in class universum.studios.android.preference.SharedPreference
Saves the current value of this preference into the given shared preferences.
setCachingEnabled(boolean) - Method in class universum.studios.android.preference.PreferencesManager
Enables/disables the caching SharedPreference's values.
setMode(int) - Method in class universum.studios.android.preference.PreferencesManager
Sets the actual file creation mode for shared preferences.
setSharedPreferencesName(String) - Method in class universum.studios.android.preference.PreferencesManager
Sets the actual name for shared preferences.
SharedPreference<Type> - Class in universum.studios.android.preference
Base implementation of shared preference object used by PreferencesManager to manage simplified storing and retrieving values from shared preferences.
SharedPreference(String, Type) - Constructor for class universum.studios.android.preference.SharedPreference
Creates a new instance of SharedPreference with the given key and default value.
SharedPreference(int, Type) - Constructor for class universum.studios.android.preference.SharedPreference
Creates a new instance of SharedPreference with the given key resource and default value.
SharedPreference.PreferenceChangeCallback<PreferenceType> - Interface in universum.studios.android.preference
Callback that can be used to listen for changes in value of a specific SharedPreference implementation.
StringPreference - Class in universum.studios.android.preference
A SharedPreference implementation that may be used to manage (store/retrieve) a String preference value within SharedPreferences.
StringPreference(String, String) - Constructor for class universum.studios.android.preference.StringPreference
Creates a new instance of StringPreference.
StringPreference(int, String) - Constructor for class universum.studios.android.preference.StringPreference
Creates a new instance of StringPreference.

U

universum.studios.android.preference - package universum.studios.android.preference
Provides classes that may be used to store or obtain data into/from the Android system SharedPreferences in a simplified 'direct' fashion.
unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener) - Method in class universum.studios.android.preference.PreferencesManager
Same as SharedPreferences.unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener).
updateValue(Type) - Method in class universum.studios.android.preference.SharedPreference
Updates the actual value of this preference to the given one.
A B C D E F G I K L M O P R S U 
Skip navigation links
Android Preferences 1.0.1 Documentation