PersistableBundle

Kotlin |Java

class PersistableBundle : BaseBundle, Cloneable, Parcelable

kotlin.Any
↳	android.os.BaseBundle
	↳	android.os.PersistableBundle

A mapping from String keys to values of various types. The set of types supported by this class is purposefully restricted to simple objects that can safely be persisted to and restored from disk.

Warning: Note that PersistableBundle is a lazy container and as such it does NOT implement equals(java.lang.Object) or hashCode().

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`PersistableBundle()` Constructs a new, empty PersistableBundle.
`PersistableBundle(capacity: Int)` Constructs a new, empty PersistableBundle sized to hold the given number of elements.
`PersistableBundle(b: PersistableBundle!)` Constructs a PersistableBundle containing a copy of the mappings from the given PersistableBundle.

Public methods
Any	`clone()` Clones the current PersistableBundle.
PersistableBundle!	`deepCopy()` Make a deep copy of the given bundle.
Int	`describeContents()` Report the nature of this Parcelable's contents
PersistableBundle?	`getPersistableBundle(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Unit	`putPersistableBundle(key: String?, value: PersistableBundle?)` Inserts a PersistableBundle value into the mapping of this Bundle, replacing any existing value for the given key.
static PersistableBundle	`readFromStream(inputStream: InputStream)` Reads a `PersistableBundle` from an `InputStream`.
String	`toString()` Returns a string representation of the `PersistableBundle` that may be suitable for debugging.
Unit	`writeToParcel(parcel: Parcel, flags: Int)` Writes the PersistableBundle contents to a Parcel, typically in order for it to be passed through an IBinder connection.
Unit	`writeToStream(outputStream: OutputStream)` Writes the content of the `PersistableBundle` to a `OutputStream`.

Inherited functions

From class BaseBundle

`Unit`	`clear()` Removes all elements from the mapping of this Bundle. Recycles the underlying parcel if it is still present.
`Boolean`	`containsKey(key: String!)` Returns true if the given key is contained in the mapping of this Bundle.
`Any?`	`get(key: String!)` Returns the entry with the given key as an object.
`Boolean`	`getBoolean(key: String!)` Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
`Boolean`	`getBoolean(key: String!, defaultValue: Boolean)` Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
`BooleanArray?`	`getBooleanArray(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
`Double`	`getDouble(key: String!)` Returns the value associated with the given key, or 0.0 if no mapping of the desired type exists for the given key.
`Double`	`getDouble(key: String!, defaultValue: Double)` Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
`DoubleArray?`	`getDoubleArray(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
`Int`	`getInt(key: String!)` Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.
`Int`	`getInt(key: String!, defaultValue: Int)` Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
`IntArray?`	`getIntArray(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
`Long`	`getLong(key: String!)` Returns the value associated with the given key, or 0L if no mapping of the desired type exists for the given key.
`Long`	`getLong(key: String!, defaultValue: Long)` Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
`LongArray?`	`getLongArray(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
`String?`	`getString(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
`String!`	`getString(key: String?, defaultValue: String!)` Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key or if a null value is explicitly associated with the given key.
`Array<String!>?`	`getStringArray(key: String?)` Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
`Boolean`	`isEmpty()` Returns true if the mapping of this Bundle is empty, false otherwise.
`MutableSet<String!>!`	`keySet()` Returns a Set containing the Strings used as keys in this Bundle.
`Unit`	`putAll(bundle: PersistableBundle!)` Inserts all mappings from the given PersistableBundle into this BaseBundle.
`Unit`	`putBoolean(key: String?, value: Boolean)` Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`putBooleanArray(key: String?, value: BooleanArray?)` Inserts a boolean array value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`putDouble(key: String?, value: Double)` Inserts a double value into the mapping of this Bundle, replacing any existing value for the given key.
`Unit`	`putDoubleArray(key: String?, value: DoubleArray?)` Inserts a double array value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`putInt(key: String?, value: Int)` Inserts an int value into the mapping of this Bundle, replacing any existing value for the given key.
`Unit`	`putIntArray(key: String?, value: IntArray?)` Inserts an int array value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`putLong(key: String?, value: Long)` Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.
`Unit`	`putLongArray(key: String?, value: LongArray?)` Inserts a long array value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`putString(key: String?, value: String?)` Inserts a String value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`putStringArray(key: String?, value: Array<String!>?)` Inserts a String array value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.
`Unit`	`remove(key: String!)` Removes any entry with the given key from the mapping of this Bundle.
`Int`	`size()` Returns the number of mappings contained in this Bundle.

Properties
static Parcelable.Creator<PersistableBundle!>	`CREATOR`
static PersistableBundle!	`EMPTY` An unmodifiable `PersistableBundle` that is always `empty`.

Public constructors

PersistableBundle

Added in API level 21

PersistableBundle()

Constructs a new, empty PersistableBundle.

PersistableBundle

Added in API level 21

PersistableBundle(capacity: Int)

Constructs a new, empty PersistableBundle sized to hold the given number of elements. The PersistableBundle will grow as needed.

Parameters
`capacity`	Int: the initial capacity of the PersistableBundle

PersistableBundle

Added in API level 21

PersistableBundle(b: PersistableBundle!)

Constructs a PersistableBundle containing a copy of the mappings from the given PersistableBundle. Does only a shallow copy of the original PersistableBundle -- see deepCopy() if that is not what you want.

Parameters
`b`	PersistableBundle!: a PersistableBundle to be copied.

See Also

#deepCopy()

Public methods

clone

Added in API level 21

fun clone(): Any

Clones the current PersistableBundle. The internal map is cloned, but the keys and values to which it refers are copied by reference.

Return
`Any`	a clone of this instance.

Exceptions
`java.lang.CloneNotSupportedException`	if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

deepCopy

Added in API level 26

fun deepCopy(): PersistableBundle!

Make a deep copy of the given bundle. Traverses into inner containers and copies them as well, so they are not shared across bundles. Will traverse in to Bundle, PersistableBundle, ArrayList, and all types of primitive arrays. Other types of objects (such as Parcelable or Serializable) are referenced as-is and not copied in any way.

describeContents

Added in API level 21

fun describeContents(): Int

Report the nature of this Parcelable's contents

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getPersistableBundle

Added in API level 21

fun getPersistableBundle(key: String?): PersistableBundle?

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters
`key`	String?: a String, or null

Return
`PersistableBundle?`	a Bundle value, or null

putPersistableBundle

Added in API level 21

fun putPersistableBundle(
    key: String?, 
    value: PersistableBundle?
): Unit

Inserts a PersistableBundle value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters
`key`	String?: a String, or null
`value`	PersistableBundle?: a Bundle object, or null

readFromStream

Added in API level 30

static fun readFromStream(inputStream: InputStream): PersistableBundle

Reads a PersistableBundle from an InputStream.

The stream must be generated by writeToStream.

Parameters
`inputStream`	InputStream: This value cannot be `null`.

Return
`PersistableBundle`	This value cannot be `null`.

See Also

#writeToStream

toString

Added in API level 21

fun toString(): String

Returns a string representation of the PersistableBundle that may be suitable for debugging. It won't print the internal map if its content hasn't been unparcelled.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 21

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

Writes the PersistableBundle contents to a Parcel, typically in order for it to be passed through an IBinder connection.

Parameters
`dest`	The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
`parcel`	Parcel: The parcel to copy this bundle to.

writeToStream

Added in API level 30

fun writeToStream(outputStream: OutputStream): Unit

Writes the content of the PersistableBundle to a OutputStream.

The content can be read by a readFromStream.

Parameters
`outputStream`	OutputStream: This value cannot be `null`.

See Also

#readFromStream

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<PersistableBundle!>

EMPTY

Added in API level 21

static val EMPTY: PersistableBundle!

An unmodifiable PersistableBundle that is always empty.