android.content
public interface
public interface
android.content.SharedPreferences
| 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.
Note: currently this class does not support use across multiple processes. This will be added later.
Nested Classes
| SharedPreferences.Editor | Interface used for modifying values in a SharedPreferences object. |
See Also
Summary
Public Methods
| Editor | edit() | ||||
| 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. | |||||
| Map | getAll() | ||||
| Retrieve all values from the preferences. | |||||
| boolean | getBoolean(String key, boolean defValue) | ||||
| Retrieve a boolean value from the preferences. | |||||
| float | getFloat(String key, float defValue) | ||||
| Retrieve a float value from the preferences. | |||||
| int | getInt(String key, int defValue) | ||||
| Retrieve an int value from the preferences. | |||||
| long | getLong(String key, long defValue) | ||||
| Retrieve a long value from the preferences. | |||||
| String | getString(String key, String defValue) | ||||
| Retrieve a String value from the preferences. | |||||
Details
Public Methods
public Editor edit()
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.
Returns
- Returns a new instance of the SharedPreferences.Editor interface, allowing you to modify the values in this SharedPreferences object.
public Map getAll()
Retrieve all values from the preferences.
Returns
- Returns a map containing a list of pairs key/value representing the preferences.
Throws
| NullPointerException |
|---|
public boolean getBoolean(String key, boolean defValue)
Retrieve a boolean value from the preferences.
Parameters
| key | The name of the preference to retrieve. |
|---|---|
| defValue | Value to return if this preference does not exist. |
Returns
- Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a boolean.
Throws
| ClassCastException |
|---|
public float getFloat(String key, float defValue)
Retrieve a float value from the preferences.
Parameters
| key | The name of the preference to retrieve. |
|---|---|
| defValue | Value to return if this preference does not exist. |
Returns
- Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a float.
Throws
| ClassCastException |
|---|
public int getInt(String key, int defValue)
Retrieve an int value from the preferences.
Parameters
| key | The name of the preference to retrieve. |
|---|---|
| defValue | Value to return if this preference does not exist. |
Returns
- Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not an int.
Throws
| ClassCastException |
|---|
public long getLong(String key, long defValue)
Retrieve a long value from the preferences.
Parameters
| key | The name of the preference to retrieve. |
|---|---|
| defValue | Value to return if this preference does not exist. |
Returns
- Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a long.
Throws
| ClassCastException |
|---|
public String getString(String key, String defValue)
Retrieve a String value from the preferences.
Parameters
| key | The name of the preference to retrieve. |
|---|---|
| defValue | Value to return if this preference does not exist. |
Returns
- Returns the preference value if it exists, or defValue. Throws ClassCastException if there is a preference with this name that is not a String.
Throws
| ClassCastException |
|---|