BundleCompat
class BundleCompat
Helper for accessing features in Bundle.
Summary
Public functions |
|
|---|---|
java-static IBinder? |
@ReplaceWith(expression = "bundle.getBinder(key)")This function is deprecated. Use |
java-static T? |
<T> getParcelable(in: Bundle, key: String?, clazz: Class<T!>)Returns the value associated with the given key or |
java-static Array<Parcelable!>? |
getParcelableArray(in: Bundle, key: String?, clazz: Class<Parcelable!>)Returns the value associated with the given key, or |
java-static ArrayList<T!>? |
<T> getParcelableArrayList(in: Bundle, key: String?, clazz: Class<T!>)Returns the value associated with the given key, or |
java-static T? |
<T : Serializable?> getSerializable(in: Bundle, key: String?, clazz: Class<T!>)Returns the value associated with the given key or |
java-static SparseArray<T!>? |
<T> getSparseParcelableArray(in: Bundle, key: String?, clazz: Class<T!>)Returns the value associated with the given key, or |
java-static Unit |
@ReplaceWith(expression = "bundle.putBinder(key, binder)")This function is deprecated. Use |
Public functions
@ReplaceWith(expression = "bundle.getBinder(key)")
java-static fungetBinder(bundle: Bundle, key: String?): IBinder?
A convenience method to handle getting an IBinder inside a Bundle for all Android versions.
getParcelable
java-static fun <T> getParcelable(in: Bundle, 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
nullvalue 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 with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.
Compatibility behavior:
- SDK 34 and above, this method matches platform behavior.
- SDK 33 and below, the object type is checked after deserialization.
| Parameters | |
|---|---|
in: Bundle |
The bundle to retrieve from. |
key: String? |
a String, or |
clazz: Class<T!> |
The type of the object expected |
| Returns | |
|---|---|
T? |
a Parcelable value, or |
getParcelableArray
java-static fun getParcelableArray(in: Bundle, key: String?, clazz: Class<Parcelable!>): Array<Parcelable!>?
Returns the value associated with the given key, or null if:
- No mapping of the desired type exists for the given key.
- A
nullvalue 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 with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.
Compatibility behavior:
- SDK 34 and above, this method matches platform behavior.
- SDK 33 and below, this method will not check the array elements' types.
| Parameters | |
|---|---|
in: Bundle |
The bundle to retrieve from. |
key: String? |
a String, or |
clazz: Class<Parcelable!> |
The type of the items inside the array. This is only verified when unparceling. |
| Returns | |
|---|---|
Array<Parcelable!>? |
a Parcelable[] value, or |
getParcelableArrayList
java-static fun <T> getParcelableArrayList(in: Bundle, key: String?, clazz: Class<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
nullvalue 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 with the proper ClassLoader first. Otherwise, this method might throw an exception or return null.
Compatibility behavior:
- SDK 34 and above, this method matches platform behavior.
- SDK 33 and below, this method will not check the list elements' types.
| Parameters | |
|---|---|
in: Bundle |
The bundle to retrieve from. |
key: String? |
a String, or |
clazz: Class<T!> |
The type of the items inside the array list. This is only verified when unparceling. |
| Returns | |
|---|---|
ArrayList<T!>? |
an ArrayListvalue, or |
getSerializable
java-static fun <T : Serializable?> getSerializable(in: Bundle, 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
nullvalue is explicitly associated with the key. - The object is not of type
clazz.
- SDK 34 and above, this method matches platform behavior.
- SDK 33 and below, the object type is checked after deserialization.
| Parameters | |
|---|---|
in: Bundle |
The bundle to retrieve from. |
key: String? |
a String, or |
clazz: Class<T!> |
The type of the object expected |
| Returns | |
|---|---|
T? |
a Serializable value, or |
getSparseParcelableArray
java-static fun <T> getSparseParcelableArray(in: Bundle, key: String?, clazz: Class<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
nullvalue is explicitly associated with the key. - The object is not of type
clazz.
- SDK 34 and above, this method matches platform behavior.
- SDK 33 and below, this method will not check the array elements' types.
| Parameters | |
|---|---|
in: Bundle |
The bundle to retrieve from. |
key: String? |
a String, or null |
clazz: Class<T!> |
The type of the items inside the sparse array. This is only verified when unparceling. |
| Returns | |
|---|---|
SparseArray<T!>? |
a SparseArray of T values, or null |