1 /* 2 * Copyright (C) 2017 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package androidx.core.content 18 19 import android.annotation.SuppressLint 20 import android.content.SharedPreferences 21 22 /** 23 * Allows editing of this preference instance with a call to [apply][SharedPreferences.Editor.apply] 24 * or [commit][SharedPreferences.Editor.commit] to persist the changes. 25 * Default behaviour is [apply][SharedPreferences.Editor.apply]. 26 * ``` 27 * prefs.edit { 28 * putString("key", value) 29 * } 30 * ``` 31 * To [commit][SharedPreferences.Editor.commit] changes: 32 * ``` 33 * prefs.edit(commit = true) { 34 * putString("key", value) 35 * } 36 * ``` 37 */ 38 @SuppressLint("ApplySharedPref") 39 inline fun SharedPreferences.edit( 40 commit: Boolean = false, 41 action: SharedPreferences.Editor.() -> Unit 42 ) { 43 val editor = edit() 44 action(editor) 45 if (commit) { 46 editor.commit() 47 } else { 48 editor.apply() 49 } 50 } 51
