Skip to content

Most visited

Recently visited

navigation

PreferenceManager

public class PreferenceManager
extends Object

java.lang.Object
   ↳ android.preference.PreferenceManager


Used to help create Preference hierarchies from activities or XML.

In most cases, clients should use addPreferencesFromIntent(Intent) or addPreferencesFromResource(int).

See also:

Summary

Nested classes

interface PreferenceManager.OnActivityDestroyListener

Interface definition for a class that will be called when the container's activity is destroyed. 

interface PreferenceManager.OnActivityResultListener

Interface definition for a class that will be called when the container's activity receives an activity result. 

interface PreferenceManager.OnActivityStopListener

Interface definition for a class that will be called when the container's activity is stopped. 

Constants

String KEY_HAS_SET_DEFAULT_VALUES

String METADATA_KEY_PREFERENCES

The Activity meta-data key for its XML preference hierarchy.

Public methods

PreferenceScreen createPreferenceScreen(Context context)
Preference findPreference(CharSequence key)

Finds a Preference based on its key.

static SharedPreferences getDefaultSharedPreferences(Context context)

Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.

static String getDefaultSharedPreferencesName(Context context)

Returns the name used for storing default shared preferences.

PreferenceDataStore getPreferenceDataStore()

Returns the PreferenceDataStore associated with this manager or null if the default SharedPreferences are used instead.

SharedPreferences getSharedPreferences()

Gets a SharedPreferences instance that preferences managed by this will use.

int getSharedPreferencesMode()

Returns the current mode of the SharedPreferences file that preferences managed by this will use.

String getSharedPreferencesName()

Returns the current name of the SharedPreferences file that preferences managed by this will use.

boolean isStorageDefault()

Indicates if the storage location used internally by this class is the default provided by the hosting Context.

boolean isStorageDeviceProtected()

Indicates if the storage location used internally by this class is backed by device-protected storage.

static void setDefaultValues(Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)

Similar to setDefaultValues(Context, int, boolean) but allows the client to provide the filename and mode of the shared preferences file.

static void setDefaultValues(Context context, int resId, boolean readAgain)

Sets the default values from an XML preference file by reading the values defined by each Preference item's android:defaultValue attribute.

void setPreferenceDataStore(PreferenceDataStore dataStore)

Sets a PreferenceDataStore to be used by all Preferences associated with this manager that don't have a custom PreferenceDataStore assigned via setPreferenceDataStore(PreferenceDataStore).

void setSharedPreferencesMode(int sharedPreferencesMode)

Sets the mode of the SharedPreferences file that preferences managed by this will use.

void setSharedPreferencesName(String sharedPreferencesName)

Sets the name of the SharedPreferences file that preferences managed by this will use.

void setStorageDefault()

Sets the storage location used internally by this class to be the default provided by the hosting Context.

void setStorageDeviceProtected()

Explicitly set the storage location used internally by this class to be device-protected storage.

Inherited methods

From class java.lang.Object

Constants

KEY_HAS_SET_DEFAULT_VALUES

added in API level 1
String KEY_HAS_SET_DEFAULT_VALUES

Constant Value: "_has_set_default_values"

METADATA_KEY_PREFERENCES

added in API level 1
String METADATA_KEY_PREFERENCES

The Activity meta-data key for its XML preference hierarchy.

Constant Value: "android.preference"

Public methods

createPreferenceScreen

added in API level 1
PreferenceScreen createPreferenceScreen (Context context)

Parameters
context Context

Returns
PreferenceScreen

findPreference

added in API level 1
Preference findPreference (CharSequence key)

Finds a Preference based on its key.

Parameters
key CharSequence: the key of the preference to retrieve

Returns
Preference the Preference with the key, or null

getDefaultSharedPreferences

added in API level 1
SharedPreferences getDefaultSharedPreferences (Context context)

Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.

Parameters
context Context: The context of the preferences whose values are wanted.

Returns
SharedPreferences A SharedPreferences instance that can be used to retrieve and listen to values of the preferences.

getDefaultSharedPreferencesName

added in API level 24
String getDefaultSharedPreferencesName (Context context)

Returns the name used for storing default shared preferences.

Parameters
context Context

Returns
String

getPreferenceDataStore

added in API level 26
PreferenceDataStore getPreferenceDataStore ()

Returns the PreferenceDataStore associated with this manager or null if the default SharedPreferences are used instead.

Returns
PreferenceDataStore The PreferenceDataStore associated with this manager or null if none.

getSharedPreferences

added in API level 1
SharedPreferences getSharedPreferences ()

Gets a SharedPreferences instance that preferences managed by this will use.

Returns
SharedPreferences a SharedPreferences instance pointing to the file that contains the values of preferences that are managed by this PreferenceManager. If a PreferenceDataStore has been set, this method returns null.

getSharedPreferencesMode

added in API level 1
int getSharedPreferencesMode ()

Returns the current mode of the SharedPreferences file that preferences managed by this will use.

Returns
int The mode that can be passed to getSharedPreferences(String, int).

getSharedPreferencesName

added in API level 1
String getSharedPreferencesName ()

Returns the current name of the SharedPreferences file that preferences managed by this will use.

Returns
String The name that can be passed to getSharedPreferences(String, int).

isStorageDefault

added in API level 24
boolean isStorageDefault ()

Indicates if the storage location used internally by this class is the default provided by the hosting Context.

Returns
boolean

isStorageDeviceProtected

added in API level 24
boolean isStorageDeviceProtected ()

Indicates if the storage location used internally by this class is backed by device-protected storage.

Returns
boolean

setDefaultValues

added in API level 1
void setDefaultValues (Context context, 
                String sharedPreferencesName, 
                int sharedPreferencesMode, 
                int resId, 
                boolean readAgain)

Similar to setDefaultValues(Context, int, boolean) but allows the client to provide the filename and mode of the shared preferences file.

Parameters
context Context: The context of the shared preferences.

sharedPreferencesName String: A custom name for the shared preferences file.

sharedPreferencesMode int: The file creation mode for the shared preferences file, such as MODE_PRIVATE or MODE_PRIVATE

resId int: The resource ID of the preference XML file.

readAgain boolean: Whether to re-read the default values. If false, this method will set the default values only if this method has never been called in the past (or if the KEY_HAS_SET_DEFAULT_VALUES in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set readAgain to true.

Note: this will NOT reset preferences back to their default values. For that functionality, use getDefaultSharedPreferences(Context) and clear it followed by a call to this method with this parameter set to true.

setDefaultValues

added in API level 1
void setDefaultValues (Context context, 
                int resId, 
                boolean readAgain)

Sets the default values from an XML preference file by reading the values defined by each Preference item's android:defaultValue attribute. This should be called by the application's main activity.

Parameters
context Context: The context of the shared preferences.

resId int: The resource ID of the preference XML file.

readAgain boolean: Whether to re-read the default values. If false, this method sets the default values only if this method has never been called in the past (or if the KEY_HAS_SET_DEFAULT_VALUES in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set readAgain to true.

Note: this will NOT reset preferences back to their default values. For that functionality, use getDefaultSharedPreferences(Context) and clear it followed by a call to this method with this parameter set to true.

setPreferenceDataStore

added in API level 26
void setPreferenceDataStore (PreferenceDataStore dataStore)

Sets a PreferenceDataStore to be used by all Preferences associated with this manager that don't have a custom PreferenceDataStore assigned via setPreferenceDataStore(PreferenceDataStore). Also if the data store is set, the child preferences won't use SharedPreferences as long as they are assigned to this manager.

Parameters
dataStore PreferenceDataStore: The PreferenceDataStore to be used by this manager.

setSharedPreferencesMode

added in API level 1
void setSharedPreferencesMode (int sharedPreferencesMode)

Sets the mode of the SharedPreferences file that preferences managed by this will use.

Parameters
sharedPreferencesMode int: The mode of the SharedPreferences file.

setSharedPreferencesName

added in API level 1
void setSharedPreferencesName (String sharedPreferencesName)

Sets the name of the SharedPreferences file that preferences managed by this will use.

If custom PreferenceDataStore is set, this won't override its usage.

Parameters
sharedPreferencesName String: The name of the SharedPreferences file.

setStorageDefault

added in API level 24
void setStorageDefault ()

Sets the storage location used internally by this class to be the default provided by the hosting Context.

setStorageDeviceProtected

added in API level 24
void setStorageDeviceProtected ()

Explicitly set the storage location used internally by this class to be device-protected storage.

On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).

Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)