Bundle

Bundle

Bundle()

Constructs a new, empty Bundle.

Bundle

Bundle(b: Bundle!)

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

Bundle

Bundle(b: PersistableBundle!)

Constructs a Bundle containing a copy of the mappings from the given PersistableBundle. Does only a shallow copy of the PersistableBundle -- see PersistableBundle.deepCopy() if you don't want that.

Bundle

Bundle(capacity: Int)

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

Bundle

Bundle(loader: ClassLoader!)

Constructs a new, empty Bundle that uses a specific ClassLoader for instantiating Parcelable and Serializable objects.

clear

fun clear(): Unit

Removes all elements from the mapping of this Bundle.

clone

fun clone(): Any

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

deepCopy

fun deepCopy(): Bundle!

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

fun describeContents(): Int

Report the nature of this Parcelable's contents

getBinder

fun getBinder(key: String?): IBinder?

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.

getBundle

fun getBundle(key: String?): Bundle?

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.

getByte

fun getByte(key: String!): Byte

Returns the value associated with the given key, or (byte) 0 if no mapping of the desired type exists for the given key.

getByte

fun getByte(
    key: String!, 
    defaultValue: Byte
): Byte!

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

getByteArray

fun getByteArray(key: String?): ByteArray?

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.

getChar

fun getChar(key: String!): Char

Returns the value associated with the given key, or (char) 0 if no mapping of the desired type exists for the given key.

getChar

fun getChar(
    key: String!, 
    defaultValue: Char
): Char

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

getCharArray

fun getCharArray(key: String?): CharArray?

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.

getCharSequence

fun getCharSequence(key: String?): CharSequence?

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.

getCharSequence

fun getCharSequence(
    key: String?, 
    defaultValue: CharSequence!
): CharSequence!

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 associatd with the given key.

getCharSequenceArray

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

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.

getCharSequenceArrayList

fun getCharSequenceArrayList(key: String?): ArrayList<CharSequence!>?

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.

getClassLoader

fun getClassLoader(): ClassLoader!

Return the ClassLoader currently associated with this Bundle.

getFloat

fun getFloat(key: String!): Float

Returns the value associated with the given key, or 0.0f if no mapping of the desired type exists for the given key.

getFloat

fun getFloat(
    key: String!, 
    defaultValue: Float
): Float

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

getFloatArray

fun getFloatArray(key: String?): FloatArray?

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.

getIntegerArrayList

fun getIntegerArrayList(key: String?): ArrayList<Int!>?

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.

getParcelable

fun <T : Parcelable!> getParcelable(key: String?): T?

Deprecated: Use the type-safer getParcelable(java.lang.String,java.lang.Class) starting from Android Build.VERSION_CODES.TIRAMISU.

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.

Note: if the expected value is not a class provided by the Android platform, you must call setClassLoader(java.lang.ClassLoader) with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.

getParcelable

fun <T : Any!> getParcelable(
    key: String?, 
    clazz: Class<T>
): T?

Returns the value associated with the given key or null if:

• No mapping of the desired type exists for the given key.
• A null value is explicitly associated with the key.
• The object is not of type clazz.

Note: if the expected value is not a class provided by the Android platform, you must call setClassLoader(java.lang.ClassLoader) with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.

Warning: the class that implements Parcelable has to be the immediately enclosing class of the runtime type of its CREATOR field (that is, Class.getEnclosingClass() has to return the parcelable implementing class), otherwise this method might throw an exception. If the Parcelable class does not enclose the CREATOR, use the deprecated getParcelable(java.lang.String) instead.

getParcelableArray

fun getParcelableArray(key: String?): Array<Parcelable!>?

Deprecated: Use the type-safer getParcelableArray(java.lang.String,java.lang.Class) starting from Android Build.VERSION_CODES.TIRAMISU.

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.

Note: if the expected value is not a class provided by the Android platform, you must call setClassLoader(java.lang.ClassLoader) with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.

getParcelableArray

fun <T : Any!> getParcelableArray(
    key: String?, 
    clazz: Class<T>
): Array<T>?

Returns the value associated with the given key, or null if:

• No mapping of the desired type exists for the given key.
• A null value is explicitly associated with the key.
• The object is not of type clazz.

Note: if the expected value is not a class provided by the Android platform, you must call setClassLoader(java.lang.ClassLoader) with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.

Warning: if the list contains items implementing the Parcelable interface, the class that implements Parcelable has to be the immediately enclosing class of the runtime type of its CREATOR field (that is, Class.getEnclosingClass() has to return the parcelable implementing class), otherwise this method might throw an exception. If the Parcelable class does not enclose the CREATOR, use the deprecated getParcelableArray(java.lang.String) instead.

getParcelableArrayList

fun <T : Parcelable!> getParcelableArrayList(key: String?): ArrayList<T>?

Deprecated: Use the type-safer getParcelable(java.lang.String,java.lang.Class) starting from Android Build.VERSION_CODES.TIRAMISU.

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.

Note: if the expected value is not a class provided by the Android platform, you must call setClassLoader(java.lang.ClassLoader) with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.

getParcelableArrayList

fun <T : Any!> getParcelableArrayList(
    key: String?, 
    clazz: Class<out T>
): ArrayList<T>?

Returns the value associated with the given key, or null if:

• No mapping of the desired type exists for the given key.
• A null value is explicitly associated with the key.
• The object is not of type clazz.

Note: if the expected value is not a class provided by the Android platform, you must call setClassLoader(java.lang.ClassLoader) with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.

Warning: if the list contains items implementing the Parcelable interface, the class that implements Parcelable has to be the immediately enclosing class of the runtime type of its CREATOR field (that is, Class.getEnclosingClass() has to return the parcelable implementing class), otherwise this method might throw an exception. If the Parcelable class does not enclose the CREATOR, use the deprecated getParcelableArrayList(java.lang.String) instead.

getSerializable

fun getSerializable(key: String?): Serializable?

Deprecated: Use the type-safer getSerializable(java.lang.String,java.lang.Class) starting from Android Build.VERSION_CODES.TIRAMISU.

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.

getSerializable

fun <T : Serializable!> getSerializable(
    key: String?, 
    clazz: Class<T>
): T?

Returns the value associated with the given key, or null if:

• No mapping of the desired type exists for the given key.
• A null value is explicitly associated with the key.
• The object is not of type clazz.

getShort

fun getShort(key: String!): Short

Returns the value associated with the given key, or (short) 0 if no mapping of the desired type exists for the given key.

getShort

fun getShort(
    key: String!, 
    defaultValue: Short
): Short

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

getShortArray

fun getShortArray(key: String?): ShortArray?

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.

getSize

fun getSize(key: String?): Size?

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.

getSizeF

fun getSizeF(key: String?): SizeF?

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.

getSparseParcelableArray

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

Deprecated: Use the type-safer getSparseParcelableArray(java.lang.String,java.lang.Class) starting from Android Build.VERSION_CODES.TIRAMISU.

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.

getSparseParcelableArray

fun <T : Any!> getSparseParcelableArray(
    key: String?, 
    clazz: Class<out T>
): SparseArray<T>?

Returns the value associated with the given key, or null if:

• No mapping of the desired type exists for the given key.
• A null value is explicitly associated with the key.
• The object is not of type clazz.

Warning: if the list contains items implementing the Parcelable interface, the class that implements Parcelable has to be the immediately enclosing class of the runtime type of its CREATOR field (that is, Class.getEnclosingClass() has to return the parcelable implementing class), otherwise this method might throw an exception. If the Parcelable class does not enclose the CREATOR, use the deprecated getSparseParcelableArray(java.lang.String) instead.

getStringArrayList

fun getStringArrayList(key: String?): ArrayList<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.

hasFileDescriptors

fun hasFileDescriptors(): Boolean

Reports whether the bundle contains any parcelled file descriptors.

putAll

fun putAll(bundle: Bundle!): Unit

Inserts all mappings from the given Bundle into this Bundle.

putBinder

fun putBinder(
    key: String?, 
    value: IBinder?
): Unit

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

You should be very careful when using this function. In many places where Bundles are used (such as inside of Intent objects), the Bundle can live longer inside of another process than the process that had originally created it. In that case, the IBinder you supply here will become invalid when your process goes away, and no longer usable, even if a new process is created for you later on.

putBundle

fun putBundle(
    key: String?, 
    value: Bundle?
): Unit

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

putByte

fun putByte(
    key: String?, 
    value: Byte
): Unit

Inserts a byte value into the mapping of this Bundle, replacing any existing value for the given key.

putByteArray

fun putByteArray(
    key: String?, 
    value: ByteArray?
): Unit

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

putChar

fun putChar(
    key: String?, 
    value: Char
): Unit

Inserts a char value into the mapping of this Bundle, replacing any existing value for the given key.

putCharArray

fun putCharArray(
    key: String?, 
    value: CharArray?
): Unit

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

putCharSequence

fun putCharSequence(
    key: String?, 
    value: CharSequence?
): Unit

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

putCharSequenceArray

fun putCharSequenceArray(
    key: String?, 
    value: Array<CharSequence!>?
): Unit

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

putCharSequenceArrayList

fun putCharSequenceArrayList(
    key: String?, 
    value: ArrayList<CharSequence!>?
): Unit

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

putFloat

fun putFloat(
    key: String?, 
    value: Float
): Unit

Inserts a float value into the mapping of this Bundle, replacing any existing value for the given key.

putFloatArray

fun putFloatArray(
    key: String?, 
    value: FloatArray?
): Unit

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

putIntegerArrayList

fun putIntegerArrayList(
    key: String?, 
    value: ArrayList<Int!>?
): Unit

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

putParcelable

fun putParcelable(
    key: String?, 
    value: Parcelable?
): Unit

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

putParcelableArray

fun putParcelableArray(
    key: String?, 
    value: Array<Parcelable!>?
): Unit

Inserts an array of Parcelable values into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

putParcelableArrayList

fun putParcelableArrayList(
    key: String?, 
    value: ArrayList<out Parcelable!>?
): Unit

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

putSerializable

fun putSerializable(
    key: String?, 
    value: Serializable?
): Unit

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

putShort

fun putShort(
    key: String?, 
    value: Short
): Unit

Inserts a short value into the mapping of this Bundle, replacing any existing value for the given key.

putShortArray

fun putShortArray(
    key: String?, 
    value: ShortArray?
): Unit

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

putSize

fun putSize(
    key: String?, 
    value: Size?
): Unit

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

putSizeF

fun putSizeF(
    key: String?, 
    value: SizeF?
): Unit

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

putSparseParcelableArray

fun putSparseParcelableArray(
    key: String?, 
    value: SparseArray<out Parcelable!>?
): Unit

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

putStringArrayList

fun putStringArrayList(
    key: String?, 
    value: ArrayList<String!>?
): Unit

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

readFromParcel

fun readFromParcel(parcel: Parcel!): Unit

Reads the Parcel contents into this Bundle, typically in order for it to be passed through an IBinder connection.

remove

fun remove(key: String!): Unit

Removes any entry with the given key from the mapping of this Bundle.

setClassLoader

fun setClassLoader(loader: ClassLoader!): Unit

Changes the ClassLoader this Bundle uses when instantiating objects.

toString

fun toString(): String

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

writeToParcel

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

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

CREATOR

static val CREATOR: Parcelable.Creator<Bundle!>

EMPTY

static val EMPTY: Bundle!

An unmodifiable Bundle that is always empty.