How to iterate through all keys of shared preferences?

Question

SharedPreferences have method getAll, but it returns no entries despite the fact some keys exist:

PreferenceManager.getDefaultSharedPreferences(this).contains("addNewAddress");

returns true

Map<String, ?> keys=PreferenceManager.getDefaultSharedPreferences(this).getAll();

returns empty map

What is wrong? How to get list of all shared preferences?

Lalit Poptani · Accepted Answer · 2012-11-05T04:36:09.840

184

What you can do is use getAll() method of SharedPreferences and get all the values in Map<String,?> and then you can easily iterate through.

Map<String,?> keys = prefs.getAll();

for(Map.Entry<String,?> entry : keys.entrySet()){
            Log.d("map values",entry.getKey() + ": " + 
                                   entry.getValue().toString());            
 }

For more you can check PrefUtil.java's dump() implementation.

edited Nov 05 '12 at 04:36

answered Feb 16 '12 at 11:44

Lalit Poptani

67,150
23
161
242

4

this is returning no values for me :( – Uniruddh Jan 07 '14 at 06:27
4

`getAll()` can return `NULL` value. It would be better to check `keys` for NULL. – trante Apr 26 '14 at 19:36
3

It's better use ``entry.getValue()`` rather than ``entry.getValue().toString()`` not to get NullPointerException) – Vlad Apr 12 '16 at 03:01

score 9 · Answer 2 · answered Feb 14 '13 at 17:05

i think the question has more to do with why

    PreferenceManager.getDefaultSharedPreferences(this).getAll()

is returning an empty/contradictory map than with how to iterate over a standard java map. the android doc isn't really crystal clear about what's going here but basically it seems like the first call ever to

    PreferenceManager.setDefaultValues(this, R.xml.preferences,false)

-- which is what you're supposed to call to initialize preferences when you start your app -- creates some kind of cached version of your preferences which causes future changes to your xml preferences file to be inconsistently handled, i.e., causing the mismatch you described in your question.

to reset this "cached entity", follow these steps (which you can sort of come up with from the above link):

    SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this);
    prefs.edit().clear();
    PreferenceManager.setDefaultValues(this, R.xml.preferences, true);

the solution I needed was a combination of this answer and http://stackoverflow.com/a/9310697/1815624 — CrandellWS, Apr 15 '16 at 18:25

score 4 · Answer 3 · answered Apr 11 '18 at 20:10

4

incase anyone wants to iterate through sharedpreferences in KOTLIN

 sharedPreferences?.all?.forEach {
     //access key using it.key & value using it.value
     Log.d("Preferences values",it.key() + ": " + it.value()             
 }

answered Apr 11 '18 at 20:10

anoo_radha

812
1
15
34

score 0 · Answer 4 · answered Feb 18 '21 at 11:20

0

In Kotlin is very easey, you can change FILE_PREF_XML for you preferences file

getSharedPreferences("FILE_PREF_XML", Context.MODE_PRIVATE).all?.forEach {
    Log.d(TAG,"shared pref(" + it.key + ") = " + it.value)
}

answered Feb 18 '21 at 11:20

Codelaby

2,604
1
25
25

How to iterate through all keys of shared preferences?

4 Answers4

Linked