SavedStateReader

operator fun contains(key: String): Boolean

Checks if the SavedState contains the specified key.

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.

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.

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.

fun getBinder(key: String): IBinder

Retrieves an IBinder value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getBinderOrNull(key: String): IBinder?

Retrieves a IBinder value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getBoolean(key: String): Boolean

Retrieves a Boolean value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getBooleanArray(key: String): BooleanArray

Retrieves a BooleanArray value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getBooleanArrayOrNull(key: String): BooleanArray?

Retrieves a BooleanArray value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getBooleanOrNull(key: String): Boolean?

Retrieves a Boolean value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

fun getChar(key: String): Char

Retrieves a Char value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getCharArray(key: String): CharArray

Retrieves a CharSequence value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getCharArrayOrNull(key: String): CharArray?

Retrieves a CharArray value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getCharOrNull(key: String): Char?

Retrieves a Char value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

fun getCharSequence(key: String): CharSequence

Retrieves a CharSequence value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of CharSequence values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of CharSequence values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of CharSequence values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of CharSequence values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getCharSequenceOrNull(key: String): CharSequence?

Retrieves a CharSequence value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

fun getDouble(key: String): Double

Retrieves a Double value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getDoubleArray(key: String): DoubleArray

Retrieves a DoubleArray value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getDoubleArrayOrNull(key: String): DoubleArray?

Retrieves a DoubleArray value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getDoubleOrNull(key: String): Double?

Retrieves a Double value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

fun getFloat(key: String): Float

Retrieves a Float value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getFloatArray(key: String): FloatArray

Retrieves a FloatArray value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getFloatArrayOrNull(key: String): FloatArray?

Retrieves a FloatArray value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getFloatOrNull(key: String): Float?

Retrieves a Float value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

fun getInt(key: String): Int

Retrieves an Int value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getIntArray(key: String): IntArray

Retrieves a IntArray value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getIntArrayOrNull(key: String): IntArray?

Retrieves a IntArray value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of String values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of Int values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getIntOrNull(key: String): Int?

Retrieves an Int value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

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

Retrieves a Serializable value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Serializable value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Serializable value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Serializable value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getLong(key: String): Long

Retrieves a Long value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getLongArray(key: String): LongArray

Retrieves a LongArray value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getLongArrayOrNull(key: String): LongArray?

Retrieves a LongArray value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getLongOrNull(key: String): Long?

Retrieves a Long value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

Note: This method returns a nullable primitive, causing auto-boxing on JVM targets.

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

Retrieves a Parcelable value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Parcelable value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of Parcelable values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of Parcelable values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of Parcelable values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of Parcelable values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of Parcelable values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of Parcelable values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of Parcelable values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of Parcelable values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Parcelable value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Parcelable value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getSavedState(key: String): SavedState

Retrieves a SavedState value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of SavedState values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves an Array of SavedState values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of SavedState values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a List of SavedState values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getSavedStateOrNull(key: String): SavedState?

Retrieves a SavedState value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getSize(key: String): Size

Retrieves a Size value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getSizeF(key: String): SizeF

Retrieves a SizeF value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getSizeFOrNull(key: String): SizeF?

Retrieves a SizeF value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getSizeOrNull(key: String): Size?

Retrieves a Size value associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a SparseArray of Parcelable values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a SparseArray of Parcelable values associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Array of Parcelable values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

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

Retrieves a Array of Parcelable values associated with the specified key, or null if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.

fun getString(key: String): String

Retrieves a String value associated with the specified key, or throws an IllegalArgumentException if this SavedState does not contain a valid value for the key.

More specifically, a SavedState is considered to contain a valid value for a key if the key exists, the associated value is not null, and it is of the expected type.