SharedPreferences.edit() without a corresponding commit() or apply() call

Question

I'm using SharedPreferences for my apps' Intro Slider. However, I'm getting an error on this line:

class PrefManager {
    private SharedPreferences pref;
    private SharedPreferences.Editor editor;


    private static final String PREF_NAME = "welcome";

    private static final String IS_FIRST_TIME_LAUNCH = "IsFirstTimeLaunch";

    PrefManager(Context context) {
        int PRIVATE_MODE = 0;
        pref = context.getSharedPreferences(PREF_NAME, PRIVATE_MODE);
        editor = pref.edit();
    }

    void setFirstTimeLaunch(boolean isFirstTime) {
        editor.putBoolean(IS_FIRST_TIME_LAUNCH, isFirstTime);
        editor.commit();
    }

    boolean isFirstTimeLaunch() {
        return pref.getBoolean(IS_FIRST_TIME_LAUNCH, true);
    }

}

editor = pref.edit();

What happens if I don't call commit() or apply() after calling edit()?

All changes you make in an editor are batched, and not copied back to the original SharedPreferences until you call commit() or apply() From the docs at: https://developer.android.com/reference/android/content/SharedPreferences.Editor.html — Kuffs, Feb 07 '17 at 14:50

Joseph Lam · Accepted Answer · 2017-02-07T14:53:47.393

7

If you do not call commit() or apply(), your changes will not be saved.

Commit() writes the changes synchronously and directly to the file
Apply() writes the changes to the in-memory SharedPreferences immediately but begins an asynchronous commit to disk

edited Feb 07 '17 at 14:53

answered Feb 07 '17 at 14:52

Joseph Lam

5,289
3
14
13

Yeah, but seems like it's working like this too, I mean I don't get intro slider again after I relaunch my app? – Ege Kuzubasioglu Feb 07 '17 at 14:53
1

It looks like you are committing your changes in setFirstTimeLaunch(boolean isFirstTime). – Joseph Lam Feb 07 '17 at 14:54

score 5 · Answer 2 · answered Feb 07 '17 at 14:57

5

What happens if I don't call commit() or apply() after calling edit()?

Nothing.

answered Feb 07 '17 at 14:57

Mehmet K

2,805
1
23
35

score 5 · Answer 3 · answered Aug 07 '18 at 07:27

You can add @SuppressLint("CommitPrefEdits") to ignore this message. In my case I am using it, because I want to use the same editor field in my class.

public class ProfileManager {

    private SharedPreferences preferences;
    private SharedPreferences.Editor editor;

    @SuppressLint("CommitPrefEdits")
    @Inject
    ProfileManager(SharedPreferences preferences) {
        this.preferences = preferences;
        this.editor = preferences.edit();
    }

    public void setAccountID(int accountID) {
        editor.putInt(AppConstants.ACCOUNT_ID_KEY, accountID)
                .apply();
    }

    public int getAccountID() {
        return preferences.getInt(AppConstants.ACCOUNT_ID_KEY, AppConstants.INVALID_ACCOUNT_ID);
    }

}

g7pro · Answer 4 · 2017-02-08T05:36:32.297

Simple Method

 sharedPreferences = getSharedPreferences("ShaPreferences", Context.MODE_PRIVATE);
                SharedPreferences.Editor editor = sharedPreferences.edit();
                boolean firstTime = sharedPreferences.getBoolean("first", true);
                if (firstTime) {
                    editor.putBoolean("first", false);
                    //For commit the changes, Use either editor.commit(); or  editor.apply();.
                    editor.commit();
                    Intent i = new Intent(SplashActivity.this, StartUpActivity.class);
                    startActivity(i);
                    finish();
                } else {
                        Intent i = new Intent(SplashActivity.this, HomeActivity.class);
                        startActivity(i);
                        finish();
                }
                    }

SharedPreferences.edit() without a corresponding commit() or apply() call

4 Answers4

Linked