Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Editor

*** ** * ** ***

```
interface Editor
```

|---|
| [android.content.SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#) |

Interface used for modifying values in a `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` object. All changes you make in an editor are batched, and not copied back to the original `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` until you call `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()`

## Summary

| Public methods ||
|---|---|
| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()()` Commit your preferences changes back from this Editor to the `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` object it is editing. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#clear()()` Mark in the editor to remove *all* values from the preferences. |
| abstract [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()()` Commit your preferences changes back from this Editor to the `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` object it is editing. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#putBoolean(kotlin.String,%20kotlin.Boolean)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` Set a boolean value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#putFloat(kotlin.String,%20kotlin.Float)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)` Set a float value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#putInt(kotlin.String,%20kotlin.Int)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Set an int value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#putLong(kotlin.String,%20kotlin.Long)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` Set a long value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#putString(kotlin.String,%20kotlin.String)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?)` Set a String value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#putStringSet(kotlin.String,%20kotlin.collections.MutableSet)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!, values: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!>?)` Set a set of String values in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` is called. |
| abstract [SharedPreferences.Editor](https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#)! | `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#remove(kotlin.String)(key: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!)` Mark in the editor that a preference value should be removed, which will be done in the actual preferences once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` is called. |

## Public methods

### apply

Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun apply(): Unit
```

Commit your preferences changes back from this Editor to the `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` object it is editing. This atomically performs the requested modifications, replacing whatever is currently in the SharedPreferences.

Note that when two editors are modifying preferences at the same time, the last one to call apply wins.

Unlike `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()`, which writes its preferences out to persistent storage synchronously, `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` commits its changes to the in-memory `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` immediately but starts an asynchronous commit to disk and you won't be notified of any failures. If another editor on this `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` does a regular `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` while a `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` is still outstanding, the `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` will block until all async commits are completed as well as the commit itself.

As `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` instances are singletons within a process, it's safe to replace any instance of `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` with `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` if you were already ignoring the return value.

**Caution:** The framework ensures in-flight disk writes from `apply()` complete before switching states (such as when Activities or Services start or stop). This means that pending `apply()` calls can block the main thread during component lifecycle transitions, which is a common source of Application Not Responding (ANR) errors.

The SharedPreferences.Editor interface isn't expected to be implemented directly. However, if you previously did implement it and are now getting errors about missing `apply()`, you can simply call `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` from `apply()`.

### clear

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun clear(): SharedPreferences.Editor!
```

Mark in the editor to remove *all* values from the preferences. Once commit is called, the only remaining preferences will be any that you have defined in this editor.

Note that when committing back to the preferences, the clear is done first, regardless of whether you called clear before or after put methods on this editor.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### commit

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun commit(): Boolean
```

Commit your preferences changes back from this Editor to the `https://developer.android.com/reference/kotlin/android/content/SharedPreferences` object it is editing. This atomically performs the requested modifications, replacing whatever is currently in the SharedPreferences.

Note that when two editors are modifying preferences at the same time, the last one to call commit wins.

If you don't care about the return value and you're using this from your application's main thread, consider using `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` instead. However, note that `apply()` can also cause ANRs during component lifecycle transitions.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | Returns true if the new values were successfully written to persistent storage. |

### putBoolean

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun putBoolean(
    key: String!, 
    value: Boolean
): SharedPreferences.Editor!
```

Set a boolean value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to modify. |
| `value` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html): The new value for the preference. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### putFloat

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun putFloat(
    key: String!, 
    value: Float
): SharedPreferences.Editor!
```

Set a float value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to modify. |
| `value` | [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html): The new value for the preference. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### putInt

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun putInt(
    key: String!, 
    value: Int
): SharedPreferences.Editor!
```

Set an int value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to modify. |
| `value` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The new value for the preference. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### putLong

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun putLong(
    key: String!, 
    value: Long
): SharedPreferences.Editor!
```

Set a long value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to modify. |
| `value` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html): The new value for the preference. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### putString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun putString(
    key: String!, 
    value: String?
): SharedPreferences.Editor!
```

Set a String value in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` are called.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to modify. |
| `value` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?: The new value for the preference. Passing `null` for this argument is equivalent to calling `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#remove(kotlin.String)` with this key. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### putStringSet

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun putStringSet(
    key: String!, 
    values: MutableSet<String!>?
): SharedPreferences.Editor!
```

Set a set of String values in the preferences editor, to be written back once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` or `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#apply()` is called.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to modify. |
| `values` | [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>?: The set of new values for the preference. Passing `null` for this argument is equivalent to calling `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#remove(kotlin.String)` with this key. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |

### remove

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

```
abstract fun remove(key: String!): SharedPreferences.Editor!
```

Mark in the editor that a preference value should be removed, which will be done in the actual preferences once `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#commit()` is called.

Note that when committing back to the preferences, all removals are done first, regardless of whether you called remove before or after put methods on this editor.

| Parameters ||
|---|---|
| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The name of the preference to remove. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/content/SharedPreferences.Editor#!` | Returns a reference to the same Editor object, so you can chain put calls together. |