Android
android.content
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. 
SharedPreferences.OnSharedPreferenceChangeListener Interface definition for a callback to be invoked when a shared preference is changed. 

Summary

Public Methods

          boolean  contains(String key)
Checks whether the preferences contains a preference.
          SharedPreferences.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<String, ?>  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.
          void  registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)
Registers a callback to be invoked when a change happens to a preference.
          void  unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)
Unregisters a previous callback.

Details

Public Methods

public boolean contains(String key)

Checks whether the preferences contains a preference.

Parameters

key The name of the preference to check.

Returns

  • Returns true if the preference exists in the preferences, otherwise false.

public SharedPreferences.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<String, ?> getAll()

Retrieve all values from the preferences.

Returns

  • Returns a map containing a list of pairs key/value representing the preferences.

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.

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.

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.

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.

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.

public void registerOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)

Registers a callback to be invoked when a change happens to a preference.

Parameters

listener The callback that will run.

public void unregisterOnSharedPreferenceChangeListener(SharedPreferences.OnSharedPreferenceChangeListener listener)

Unregisters a previous callback.

Parameters

listener The callback that should be unregistered.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56