SavedStateReader

Artifact: androidx.savedstate:savedstate

Kotlin |Java

Cmn
```
value class SavedStateReader
```

An inline class that encapsulates an opaque SavedState, and provides an API for reading the platform specific state.

See also
`read`

Summary

Public functions
`operator Boolean`	`contains(key: String)` Checks if the `SavedState` contains the specified `key`.	Cmn android
`Boolean`	`contentDeepEquals(other: SavedState)` Checks if the two specified `SavedState` are deeply equal to one another.	Cmn android
`Int`	`contentDeepHashCode()` Returns a hash code based on the "deep contents" of specified `SavedState`.	Cmn android
`String`	`contentDeepToString()` Returns a string representation of the contents of this `SavedState` as if it is a `List`.	Cmn android
`IBinder`	`getBinder(key: String)` Retrieves an `IBinder` object associated with the specified key.	android
`IBinder?`	`getBinderOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`Boolean`	`getBoolean(key: String)` Retrieves a `Boolean` value associated with the specified `key`.	Cmn android
`BooleanArray`	`getBooleanArray(key: String)` Retrieves a `BooleanArray` value associated with the specified `key`.	Cmn android
`BooleanArray?`	`getBooleanArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Boolean?`	`getBooleanOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Char`	`getChar(key: String)` Retrieves a `Char` value associated with the specified `key`.	Cmn android
`CharArray`	`getCharArray(key: String)` Retrieves a `CharArray` value associated with the specified `key`.	Cmn android
`CharArray?`	`getCharArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Char?`	`getCharOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`CharSequence`	`getCharSequence(key: String)` Retrieves a `CharSequence` value associated with the specified `key`.	Cmn android
`Array<CharSequence>`	`getCharSequenceArray(key: String)` Retrieves a `CharArray` value associated with the specified `key`.	Cmn android
`Array<CharSequence>?`	`getCharSequenceArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`List<CharSequence>`	`getCharSequenceList(key: String)` Retrieves a `List` of elements of `CharArray` associated with the specified `key`.	Cmn android
`List<CharSequence>?`	`getCharSequenceListOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`CharSequence?`	`getCharSequenceOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Double`	`getDouble(key: String)` Retrieves a `Double` value associated with the specified `key`.	Cmn android
`DoubleArray`	`getDoubleArray(key: String)` Retrieves a `DoubleArray` value associated with the specified `key`.	Cmn android
`DoubleArray?`	`getDoubleArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Double?`	`getDoubleOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Float`	`getFloat(key: String)` Retrieves a `Float` value associated with the specified `key`.	Cmn android
`FloatArray`	`getFloatArray(key: String)` Retrieves a `FloatArray` value associated with the specified `key`.	Cmn android
`FloatArray?`	`getFloatArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Float?`	`getFloatOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Int`	`getInt(key: String)` Retrieves an `Int` value associated with the specified `key`.	Cmn android
`IntArray`	`getIntArray(key: String)` Retrieves a `IntArray` value associated with the specified `key`.	Cmn android
`IntArray?`	`getIntArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`List<Int>`	`getIntList(key: String)` Retrieves a `List` of elements of `Int` associated with the specified `key`.	Cmn android
`List<Int>?`	`getIntListOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Int?`	`getIntOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`inline T`	`<T : Serializable> getJavaSerializable(key: String)` Retrieves a `Serializable` object associated with the specified key.	android
`T`	`<T : Serializable> getJavaSerializable( key: String, serializableClass: KClass<T> )` Retrieves a `Serializable` object associated with the specified key.	android
`inline T?`	`<T : Serializable> getJavaSerializableOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`T?`	`<T : Serializable> getJavaSerializableOrNull( key: String, serializableClass: KClass<T> )` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`Long`	`getLong(key: String)` Retrieves an `Long` value associated with the specified `key`.	Cmn android
`LongArray`	`getLongArray(key: String)` Retrieves a `LongArray` value associated with the specified `key`.	Cmn android
`LongArray?`	`getLongArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Long?`	`getLongOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`inline T`	`<T : Parcelable> getParcelable(key: String)` Retrieves a `Parcelable` object associated with the specified key.	android
`T`	`<T : Parcelable> getParcelable(key: String, parcelableClass: KClass<T>)` Retrieves a `Parcelable` object associated with the specified key.	android
`inline Array<T>`	`<T : Parcelable> getParcelableArray(key: String)` Retrieves an `Array` of elements of `Parcelable` associated with the specified `key`.	android
`Array<T>`	`<T : Parcelable> getParcelableArray(key: String, parcelableClass: KClass<T>)` Retrieves an `Array` of elements of `Parcelable` associated with the specified `key`.	android
`inline Array<T>?`	`<T : Parcelable> getParcelableArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`Array<T>?`	`<T : Parcelable> getParcelableArrayOrNull( key: String, parcelableClass: KClass<T> )` Returns the value corresponding to the given `key`, or throws `IllegalArgumentException`.	android
`inline List<T>`	`<T : Parcelable> getParcelableList(key: String)` Retrieves a `List` of elements of `Parcelable` associated with the specified `key`.	android
`List<T>`	`<T : Parcelable> getParcelableList(key: String, parcelableClass: KClass<T>)` Retrieves a `List` of elements of `Parcelable` associated with the specified `key`.	android
`inline List<T>?`	`<T : Parcelable> getParcelableListOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`List<T>?`	`<T : Parcelable> getParcelableListOrNull( key: String, parcelableClass: KClass<T> )` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`inline T?`	`<T : Parcelable> getParcelableOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`T?`	`<T : Parcelable> getParcelableOrNull(key: String, parcelableClass: KClass<T>)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`SavedState`	`getSavedState(key: String)` Retrieves a `SavedState` object associated with the specified `key`.	Cmn android
`Array<SavedState>`	`getSavedStateArray(key: String)` Retrieves a `Array` of `SavedState` value associated with the specified `key`.	Cmn android
`Array<SavedState>?`	`getSavedStateArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`List<SavedState>`	`getSavedStateList(key: String)` Retrieves a `List` of elements of `SavedState` associated with the specified `key`.	Cmn android
`List<SavedState>?`	`getSavedStateListOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`SavedState?`	`getSavedStateOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Size`	`getSize(key: String)` Retrieves a `Size` object associated with the specified key.	android
`SizeF`	`getSizeF(key: String)` Retrieves a `SizeF` object associated with the specified key.	android
`SizeF?`	`getSizeFOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`Size?`	`getSizeOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`inline SparseArray<T>`	`<T : Parcelable> getSparseParcelableArray(key: String)` Retrieves a `SparseArray` of elements of `Parcelable` associated with the specified `key`.	android
`SparseArray<T>`	`<T : Parcelable> getSparseParcelableArray( key: String, parcelableClass: KClass<T> )` Retrieves a `SparseArray` of elements of `Parcelable` associated with the specified `key`.	android
`inline SparseArray<T>?`	`<T : Parcelable> getSparseParcelableArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`SparseArray<T>?`	`<T : Parcelable> getSparseParcelableArrayOrNull( key: String, parcelableClass: KClass<T> )` Returns the value corresponding to the given `key`, or null if such a key is not present.	android
`String`	`getString(key: String)` Retrieves a `String` value associated with the specified `key`.	Cmn android
`Array<String>`	`getStringArray(key: String)` Retrieves a `Array` of `String` value associated with the specified `key`.	Cmn android
`Array<String>?`	`getStringArrayOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`List<String>`	`getStringList(key: String)` Retrieves a `List` of elements of `String` associated with the specified `key`.	Cmn android
`List<String>?`	`getStringListOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`String?`	`getStringOrNull(key: String)` Returns the value corresponding to the given `key`, or null if such a key is not present.	Cmn android
`Boolean`	`isEmpty()` Checks if the `SavedState` is empty (contains no key-value pairs).	Cmn android
`Boolean`	`isNull(key: String)` Checks if the `SavedState` contains a null reference for the specified `key`.	Cmn android
`Int`	`size()` Returns the number of key-value pairs in the `SavedState`.	Cmn android
`Map<String, Any?>`	`toMap()` Returns a new `Map` containing all key-value pairs from the `SavedState`.	Cmn android

Public functions

contains

Cmn android

Added in 1.3.0-alpha10

operator fun contains(key: String): Boolean

Checks if the SavedState contains the specified key.

Parameters
`key: String`	The `key` to check for.

Returns
`Boolean`	`true` if the `SavedState` contains the `key`, `false` otherwise.

contentDeepEquals

Cmn android

fun contentDeepEquals(other: SavedState): Boolean

Checks if the two specified SavedState are deeply equal to one another.

Two SavedState are considered deeply equal if they have the same size, and elements at corresponding keys are deeply equal. That is, if two corresponding elements are nested SavedState, they are also compared deeply.

If any of SavedState contains itself on any nesting level the behavior is undefined.

Parameters
`other: SavedState`	the object to compare deeply with this.

Returns
`Boolean`	`true` if the two are deeply equal, `false` otherwise.

contentDeepHashCode

Cmn android

Added in 1.3.0-alpha10

fun contentDeepHashCode(): Int

Returns a hash code based on the "deep contents" of specified SavedState. If the SavedState contains other SavedState as elements, the hash code is based on their contents and so on.

The computation of the hash code returned is as if the SavedState is a List. Nested SavedState are treated as lists too.

If any of SavedState contains itself on any nesting level the behavior is undefined.

Returns
`Int`	a deep-content-based hash code for `SavedState`.

contentDeepToString

Cmn android

Added in 1.3.0-alpha10

fun contentDeepToString(): String

Returns a string representation of the contents of this SavedState as if it is a List. Nested SavedState are treated as lists too.

If any of SavedState contains itself on any nesting level that reference is rendered as "[...]" to prevent recursion.

getBinder

android

Added in 1.3.0-alpha10

fun getBinder(key: String): IBinder

Retrieves an IBinder object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.

Returns
`IBinder`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getBinderOrNull

android

Added in 1.3.0-alpha10

fun getBinderOrNull(key: String): IBinder?

Returns the value corresponding to the given key, or null if such a key is not present.

getBoolean

Cmn android

Added in 1.3.0-alpha10

fun getBoolean(key: String): Boolean

Retrieves a Boolean value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Boolean`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getBooleanArray

Cmn android

Added in 1.3.0-alpha10

fun getBooleanArray(key: String): BooleanArray

Retrieves a BooleanArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`BooleanArray`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getBooleanArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getBooleanArrayOrNull(key: String): BooleanArray?

Returns the value corresponding to the given key, or null if such a key is not present.

getBooleanOrNull

Cmn android

Added in 1.3.0-alpha10

fun getBooleanOrNull(key: String): Boolean?

Returns the value corresponding to the given key, or null if such a key is not present.

getChar

Cmn android

Added in 1.3.0-alpha10

fun getChar(key: String): Char

Retrieves a Char value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Char`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getCharArray

Cmn android

Added in 1.3.0-alpha10

fun getCharArray(key: String): CharArray

Retrieves a CharArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`CharArray`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getCharArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getCharArrayOrNull(key: String): CharArray?

Returns the value corresponding to the given key, or null if such a key is not present.

getCharOrNull

Cmn android

Added in 1.3.0-alpha10

fun getCharOrNull(key: String): Char?

Returns the value corresponding to the given key, or null if such a key is not present.

getCharSequence

Cmn android

Added in 1.3.0-alpha10

fun getCharSequence(key: String): CharSequence

Retrieves a CharSequence value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`CharSequence`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getCharSequenceArray

Cmn android

Added in 1.3.0-alpha10

fun getCharSequenceArray(key: String): Array<CharSequence>

Retrieves a CharArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Array<CharSequence>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getCharSequenceArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getCharSequenceArrayOrNull(key: String): Array<CharSequence>?

Returns the value corresponding to the given key, or null if such a key is not present.

getCharSequenceList

Cmn android

Added in 1.3.0-alpha10

fun getCharSequenceList(key: String): List<CharSequence>

Retrieves a List of elements of CharArray associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`List<CharSequence>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getCharSequenceListOrNull

Cmn android

Added in 1.3.0-alpha10

fun getCharSequenceListOrNull(key: String): List<CharSequence>?

Returns the value corresponding to the given key, or null if such a key is not present.

getCharSequenceOrNull

Cmn android

Added in 1.3.0-alpha10

fun getCharSequenceOrNull(key: String): CharSequence?

Returns the value corresponding to the given key, or null if such a key is not present.

getDouble

Cmn android

Added in 1.3.0-alpha10

fun getDouble(key: String): Double

Retrieves a Double value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Double`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getDoubleArray

Cmn android

Added in 1.3.0-alpha10

fun getDoubleArray(key: String): DoubleArray

Retrieves a DoubleArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`DoubleArray`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getDoubleArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getDoubleArrayOrNull(key: String): DoubleArray?

Returns the value corresponding to the given key, or null if such a key is not present.

getDoubleOrNull

Cmn android

Added in 1.3.0-alpha10

fun getDoubleOrNull(key: String): Double?

Returns the value corresponding to the given key, or null if such a key is not present.

getFloat

Cmn android

Added in 1.3.0-alpha10

fun getFloat(key: String): Float

Retrieves a Float value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Float`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getFloatArray

Cmn android

Added in 1.3.0-alpha10

fun getFloatArray(key: String): FloatArray

Retrieves a FloatArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`FloatArray`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getFloatArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getFloatArrayOrNull(key: String): FloatArray?

Returns the value corresponding to the given key, or null if such a key is not present.

getFloatOrNull

Cmn android

Added in 1.3.0-alpha10

fun getFloatOrNull(key: String): Float?

Returns the value corresponding to the given key, or null if such a key is not present.

getInt

Cmn android

Added in 1.3.0-alpha10

fun getInt(key: String): Int

Retrieves an Int value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Int`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getIntArray

Cmn android

Added in 1.3.0-alpha10

fun getIntArray(key: String): IntArray

Retrieves a IntArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`IntArray`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getIntArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getIntArrayOrNull(key: String): IntArray?

Returns the value corresponding to the given key, or null if such a key is not present.

getIntList

Cmn android

Added in 1.3.0-alpha10

fun getIntList(key: String): List<Int>

Retrieves a List of elements of Int associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`List<Int>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getIntListOrNull

Cmn android

Added in 1.3.0-alpha10

fun getIntListOrNull(key: String): List<Int>?

Returns the value corresponding to the given key, or null if such a key is not present.

getIntOrNull

Cmn android

Added in 1.3.0-alpha10

fun getIntOrNull(key: String): Int?

Returns the value corresponding to the given key, or null if such a key is not present.

getJavaSerializable

android

inline fun <T : Serializable> getJavaSerializable(key: String): T

Retrieves a Serializable object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.

Returns
`T`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getJavaSerializable

android

Added in 1.3.0-alpha10

fun <T : Serializable> getJavaSerializable(
    key: String,
    serializableClass: KClass<T>
): T

Retrieves a Serializable object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.
`serializableClass: KClass<T>`	The type of the object expected

Returns
`T`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getJavaSerializableOrNull

android

inline fun <T : Serializable> getJavaSerializableOrNull(key: String): T?

Returns the value corresponding to the given key, or null if such a key is not present.

getJavaSerializableOrNull

android

Added in 1.3.0-alpha10

fun <T : Serializable> getJavaSerializableOrNull(
    key: String,
    serializableClass: KClass<T>
): T?

Returns the value corresponding to the given key, or null if such a key is not present.

getLong

Cmn android

Added in 1.3.0-alpha10

fun getLong(key: String): Long

Retrieves an Long value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Long`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getLongArray

Cmn android

Added in 1.3.0-alpha10

fun getLongArray(key: String): LongArray

Retrieves a LongArray value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`LongArray`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getLongArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getLongArrayOrNull(key: String): LongArray?

Returns the value corresponding to the given key, or null if such a key is not present.

getLongOrNull

Cmn android

Added in 1.3.0-alpha10

fun getLongOrNull(key: String): Long?

Returns the value corresponding to the given key, or null if such a key is not present.

getParcelable

android

inline fun <T : Parcelable> getParcelable(key: String): T

Retrieves a Parcelable object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.

Returns
`T`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getParcelable

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getParcelable(key: String, parcelableClass: KClass<T>): T

Retrieves a Parcelable object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.
`parcelableClass: KClass<T>`	The type of the object expected

Returns
`T`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getParcelableArray

android

inline fun <T : Parcelable> getParcelableArray(key: String): Array<T>

Retrieves an Array of elements of Parcelable associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Array<T>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getParcelableArray

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getParcelableArray(key: String, parcelableClass: KClass<T>): Array<T>

Retrieves an Array of elements of Parcelable associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.
`parcelableClass: KClass<T>`	The type of the object expected

Returns
`Array<T>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getParcelableArrayOrNull

android

inline fun <T : Parcelable> getParcelableArrayOrNull(key: String): Array<T>?

Returns the value corresponding to the given key, or null if such a key is not present.

getParcelableArrayOrNull

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getParcelableArrayOrNull(
    key: String,
    parcelableClass: KClass<T>
): Array<T>?

Returns the value corresponding to the given key, or throws IllegalArgumentException.

getParcelableList

android

inline fun <T : Parcelable> getParcelableList(key: String): List<T>

Retrieves a List of elements of Parcelable associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`List<T>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getParcelableList

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getParcelableList(key: String, parcelableClass: KClass<T>): List<T>

Retrieves a List of elements of Parcelable associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.
`parcelableClass: KClass<T>`	The type of the object expected

Returns
`List<T>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getParcelableListOrNull

android

inline fun <T : Parcelable> getParcelableListOrNull(key: String): List<T>?

Returns the value corresponding to the given key, or null if such a key is not present.

getParcelableListOrNull

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getParcelableListOrNull(
    key: String,
    parcelableClass: KClass<T>
): List<T>?

Returns the value corresponding to the given key, or null if such a key is not present.

getParcelableOrNull

android

inline fun <T : Parcelable> getParcelableOrNull(key: String): T?

Returns the value corresponding to the given key, or null if such a key is not present.

getParcelableOrNull

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getParcelableOrNull(key: String, parcelableClass: KClass<T>): T?

Returns the value corresponding to the given key, or null if such a key is not present.

getSavedState

Cmn android

Added in 1.3.0-alpha10

fun getSavedState(key: String): SavedState

Retrieves a SavedState object associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`SavedState`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSavedStateArray

Cmn android

Added in 1.3.0-alpha10

fun getSavedStateArray(key: String): Array<SavedState>

Retrieves a Array of SavedState value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Array<SavedState>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSavedStateArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getSavedStateArrayOrNull(key: String): Array<SavedState>?

Returns the value corresponding to the given key, or null if such a key is not present.

getSavedStateList

Cmn android

Added in 1.3.0-alpha10

fun getSavedStateList(key: String): List<SavedState>

Retrieves a List of elements of SavedState associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`List<SavedState>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSavedStateListOrNull

Cmn android

Added in 1.3.0-alpha10

fun getSavedStateListOrNull(key: String): List<SavedState>?

Returns the value corresponding to the given key, or null if such a key is not present.

getSavedStateOrNull

Cmn android

Added in 1.3.0-alpha10

fun getSavedStateOrNull(key: String): SavedState?

Returns the value corresponding to the given key, or null if such a key is not present.

getSize

android

Added in 1.3.0-alpha10

fun getSize(key: String): Size

Retrieves a Size object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.

Returns
`Size`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSizeF

android

Added in 1.3.0-alpha10

fun getSizeF(key: String): SizeF

Retrieves a SizeF object associated with the specified key.

Parameters
`key: String`	The key to retrieve the value for.

Returns
`SizeF`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSizeFOrNull

android

Added in 1.3.0-alpha10

fun getSizeFOrNull(key: String): SizeF?

Returns the value corresponding to the given key, or null if such a key is not present.

getSizeOrNull

android

Added in 1.3.0-alpha10

fun getSizeOrNull(key: String): Size?

Returns the value corresponding to the given key, or null if such a key is not present.

getSparseParcelableArray

android

inline fun <T : Parcelable> getSparseParcelableArray(key: String): SparseArray<T>

Retrieves a SparseArray of elements of Parcelable associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`SparseArray<T>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the key is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSparseParcelableArray

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getSparseParcelableArray(
    key: String,
    parcelableClass: KClass<T>
): SparseArray<T>

Retrieves a SparseArray of elements of Parcelable associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.
`parcelableClass: KClass<T>`	The type of the object expected

Returns
`SparseArray<T>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getSparseParcelableArrayOrNull

android

inline fun <T : Parcelable> getSparseParcelableArrayOrNull(key: String): SparseArray<T>?

Returns the value corresponding to the given key, or null if such a key is not present.

getSparseParcelableArrayOrNull

android

Added in 1.3.0-alpha10

fun <T : Parcelable> getSparseParcelableArrayOrNull(
    key: String,
    parcelableClass: KClass<T>
): SparseArray<T>?

Returns the value corresponding to the given key, or null if such a key is not present.

getString

Cmn android

Added in 1.3.0-alpha10

fun getString(key: String): String

Retrieves a String value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`String`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getStringArray

Cmn android

Added in 1.3.0-alpha10

fun getStringArray(key: String): Array<String>

Retrieves a Array of String value associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`Array<String>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getStringArrayOrNull

Cmn android

Added in 1.3.0-alpha10

fun getStringArrayOrNull(key: String): Array<String>?

Returns the value corresponding to the given key, or null if such a key is not present.

getStringList

Cmn android

Added in 1.3.0-alpha10

fun getStringList(key: String): List<String>

Retrieves a List of elements of String associated with the specified key.

Parameters
`key: String`	The `key` to retrieve the value for.

Returns
`List<String>`	The value associated with the `key`.

Throws
`kotlin.IllegalArgumentException`	If the `key` is not found.
`kotlin.IllegalArgumentException`	if associated value has wrong type.

getStringListOrNull

Cmn android

Added in 1.3.0-alpha10

fun getStringListOrNull(key: String): List<String>?

Returns the value corresponding to the given key, or null if such a key is not present.

getStringOrNull

Cmn android

Added in 1.3.0-alpha10

fun getStringOrNull(key: String): String?

Returns the value corresponding to the given key, or null if such a key is not present.

isEmpty

Cmn android

Added in 1.3.0-alpha10

fun isEmpty(): Boolean

Checks if the SavedState is empty (contains no key-value pairs).

Returns
`Boolean`	`true` if the `SavedState` is empty, `false` otherwise.

isNull

Cmn android

Added in 1.3.0-alpha10

fun isNull(key: String): Boolean

Checks if the SavedState contains a null reference for the specified key.

Parameters
`key: String`	The `key` to check for.

Returns
`Boolean`	`true` if the `SavedState` contains a null reference for the `key`, `false` otherwise.

size

Cmn android

Added in 1.3.0-alpha10

fun size(): Int

Returns the number of key-value pairs in the SavedState.

Returns
`Int`	The size of the `SavedState`.

toMap

Cmn android

Added in 1.3.0-alpha10

fun toMap(): Map<String, Any?>

Returns a new Map containing all key-value pairs from the SavedState.

The returned Map does not preserve the entry iteration order of the SavedState.

IMPORTANT: All values will be copied by reference, and values within the SavedState that are also a SavedState will NOT be converted to a Map.

Returns
`Map<String, Any?>`	A `Map` containing all key-value pairs from the `SavedState`.