android.content.SharedPreferences |
Interface for accessing and modifying preference data returned by getSharedPreferences(String, int)
. For any particular set of preferences,
there is a single instance of this class that all clients share.
Modifications to the preferences must go through an SharedPreferences.Editor
object
to ensure the preference values remain in a consistent state and control
when they are committed to storage. Objects that are returned from the
various get
methods must be treated as immutable by the application.
Note: currently this class does not support use across multiple processes. This will be added later.
For more information about using SharedPreferences, read the Data Storage developer guide.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
SharedPreferences.Editor | Interface used for modifying values in a SharedPreferences
object. |
||||||||||
SharedPreferences.OnSharedPreferenceChangeListener | Interface definition for a callback to be invoked when a shared preference is changed. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Checks whether the preferences contains a preference.
| |||||||||||
Create a new Editor for these preferences, through which you can make
modifications to the data in the preferences and atomically commit those
changes back to the SharedPreferences object.
| |||||||||||
Retrieve all values from the preferences.
| |||||||||||
Retrieve a boolean value from the preferences.
| |||||||||||
Retrieve a float value from the preferences.
| |||||||||||
Retrieve an int value from the preferences.
| |||||||||||
Retrieve a long value from the preferences.
| |||||||||||
Retrieve a String value from the preferences.
| |||||||||||
Retrieve a set of String values from the preferences.
| |||||||||||
Registers a callback to be invoked when a change happens to a preference.
| |||||||||||
Unregisters a previous callback.
|
Checks whether the preferences contains a preference.
key | The name of the preference to check. |
---|
Create a new Editor for these preferences, through which you can make modifications to the data in the preferences and atomically commit those changes back to the SharedPreferences object.
Note that you must call commit()
to have any
changes you perform in the Editor actually show up in the
SharedPreferences.
SharedPreferences.Editor
interface, allowing
you to modify the values in this SharedPreferences object.
Retrieve all values from the preferences.
Note that you must not modify the collection returned by this method, or alter any of its contents. The consistency of your stored data is not guaranteed if you do.
NullPointerException |
---|
Retrieve a boolean value from the preferences.
key | The name of the preference to retrieve. |
---|---|
defValue | Value to return if this preference does not exist. |
ClassCastException |
---|
Retrieve a float value from the preferences.
key | The name of the preference to retrieve. |
---|---|
defValue | Value to return if this preference does not exist. |
ClassCastException |
---|
Retrieve an int value from the preferences.
key | The name of the preference to retrieve. |
---|---|
defValue | Value to return if this preference does not exist. |
ClassCastException |
---|
Retrieve a long value from the preferences.
key | The name of the preference to retrieve. |
---|---|
defValue | Value to return if this preference does not exist. |
ClassCastException |
---|
Retrieve a String value from the preferences.
key | The name of the preference to retrieve. |
---|---|
defValue | Value to return if this preference does not exist. |
ClassCastException |
---|
Retrieve a set of String values from the preferences.
Note that you must not modify the set instance returned by this call. The consistency of the stored data is not guaranteed if you do, nor is your ability to modify the instance at all.
key | The name of the preference to retrieve. |
---|---|
defValues | Values to return if this preference does not exist. |
ClassCastException |
---|
Registers a callback to be invoked when a change happens to a preference.
listener | The callback that will run. |
---|
Unregisters a previous callback.
listener | The callback that should be unregistered. |
---|