Added in API level 1

Parcel

class Parcel
kotlin.Any
   ↳ android.os.Parcel

Container for a message (data and object references) that can be sent through an IBinder. A Parcel can contain both flattened data that will be unflattened on the other side of the IPC (using the various methods here for writing specific types, or the general Parcelable interface), and references to live IBinder objects that will result in the other side receiving a proxy IBinder connected with the original IBinder in the Parcel.

Parcel is not a general-purpose serialization mechanism. This class (and the corresponding Parcelable API for placing arbitrary objects into a Parcel) is designed as a high-performance IPC transport. As such, it is not appropriate to place any Parcel data in to persistent storage: changes in the underlying implementation of any of the data in the Parcel can render older data unreadable.

The bulk of the Parcel API revolves around reading and writing data of various types. There are six major classes of such functions available.

Primitives

The most basic data functions are for writing and reading primitive data types: writeByte, readByte, writeDouble, readDouble, writeFloat, readFloat, writeInt, readInt, writeLong, readLong, writeString, readString. Most other data operations are built on top of these. The given data is written and read using the endianess of the host CPU.

Primitive Arrays

There are a variety of methods for reading and writing raw arrays of primitive objects, which generally result in writing a 4-byte length followed by the primitive data items. The methods for reading can either read the data into an existing array, or create and return a new array. These available types are:

Parcelables

The Parcelable protocol provides an extremely efficient (but low-level) protocol for objects to write and read themselves from Parcels. You can use the direct methods writeParcelable(android.os.Parcelable,int) and readParcelable(java.lang.ClassLoader) or writeParcelableArray and readParcelableArray(java.lang.ClassLoader) to write or read. These methods write both the class type and its data to the Parcel, allowing that class to be reconstructed from the appropriate class loader when later reading.

There are also some methods that provide a more efficient way to work with Parcelables: writeTypedObject, writeTypedArray, #writeTypedList, readTypedObject, createTypedArray and createTypedArrayList. These methods do not write the class information of the original object: instead, the caller of the read function must know what type to expect and pass in the appropriate Parcelable.Creator instead to properly construct the new object and read its data. (To more efficient write and read a single Parcelable object that is not null, you can directly call Parcelable.writeToParcel and Parcelable.Creator.createFromParcel yourself.)

Bundles

A special type-safe container, called Bundle, is available for key/value maps of heterogeneous values. This has many optimizations for improved performance when reading and writing data, and its type-safe API avoids difficult to debug type errors when finally marshalling the data contents into a Parcel. The methods to use are writeBundle(android.os.Bundle), readBundle(), and readBundle(java.lang.ClassLoader).

Active Objects

An unusual feature of Parcel is the ability to read and write active objects. For these objects the actual contents of the object is not written, rather a special token referencing the object is written. When reading the object back from the Parcel, you do not get a new instance of the object, but rather a handle that operates on the exact same object that was originally written. There are two forms of active objects available.

Binder objects are a core facility of Android's general cross-process communication system. The IBinder interface describes an abstract protocol with a Binder object. Any such interface can be written in to a Parcel, and upon reading you will receive either the original object implementing that interface or a special proxy implementation that communicates calls back to the original object. The methods to use are writeStrongBinder(android.os.IBinder), writeStrongInterface(android.os.IInterface), readStrongBinder(), writeBinderArray(android.os.IBinder[]), readBinderArray(android.os.IBinder[]), createBinderArray(), #writeInterfaceArray(T[]), #readInterfaceArray(T[],java.util.function.Function), createInterfaceArray(java.util.function.IntFunction,java.util.function.Function), writeBinderList(java.util.List), readBinderList(java.util.List), createBinderArrayList(), writeInterfaceList(java.util.List), readInterfaceList(java.util.List,java.util.function.Function), createInterfaceArrayList(java.util.function.Function).

FileDescriptor objects, representing raw Linux file descriptor identifiers, can be written and ParcelFileDescriptor objects returned to operate on the original file descriptor. The returned file descriptor is a dup of the original file descriptor: the object and fd is different, but operating on the same underlying file stream, with the same position, etc. The methods to use are writeFileDescriptor(java.io.FileDescriptor), readFileDescriptor().

Parcelable Containers

A final class of methods are for writing and reading standard Java containers of arbitrary types. These all revolve around the writeValue(java.lang.Object) and readValue(java.lang.ClassLoader) methods which define the types of objects allowed. The container methods are writeArray(java.lang.Object[]), readArray(java.lang.ClassLoader), writeList(java.util.List), readList(java.util.List,java.lang.ClassLoader), readArrayList(java.lang.ClassLoader), writeMap(java.util.Map), readMap(java.util.Map,java.lang.ClassLoader), writeSparseArray(android.util.SparseArray), readSparseArray(java.lang.ClassLoader).

Restricted Parcelable Containers

A final class of methods are for reading standard Java containers of restricted types. These methods replace methods for reading containers of arbitrary types from previous section starting from Android Build.VERSION_CODES#TIRAMISU. The pairing writing methods are still the same from previous section. These methods accepts additional clazz parameters as the required types. The Restricted Parcelable container methods are readArray(java.lang.ClassLoader,java.lang.Class), readList(java.util.List,java.lang.ClassLoader,java.lang.Class), readArrayList(java.lang.ClassLoader,java.lang.Class), readMap(java.util.Map,java.lang.ClassLoader,java.lang.Class,java.lang.Class), readSparseArray(java.lang.ClassLoader,java.lang.Class).

Summary

Public methods
Unit
appendFrom(parcel: Parcel!, offset: Int, length: Int)
Array<IBinder!>?

ArrayList<IBinder!>?

Read and return a new ArrayList containing IBinder objects from the parcel that was written with writeBinderList at the current dataPosition().
BooleanArray?

ByteArray?

Read and return a byte[] object from the parcel.
CharArray?

DoubleArray?

T?
createFixedArray(cls: Class<T>, vararg dimensions: Int)

Read and return a new multi-dimensional array from a parcel.
T?
createFixedArray(cls: Class<T>, asInterface: Function<IBinder!, S>, vararg dimensions: Int)

Read and return a new multi-dimensional array of typed interfaces from a parcel.
T?
createFixedArray(cls: Class<T>, c: Parcelable.Creator<S>, vararg dimensions: Int)

Read and return a new multi-dimensional array of typed parcelables from a parcel.
FloatArray?

IntArray?

Array<T>?
createInterfaceArray(newArray: IntFunction<Array<T>!>, asInterface: Function<IBinder!, T>)

Read and return a new array of T (IInterface) from the parcel.
ArrayList<T>?

Read and return a new ArrayList containing T (IInterface) objects from the parcel that was written with writeInterfaceList at the current dataPosition().
LongArray?

Array<String!>?

ArrayList<String!>?

Read and return a new ArrayList containing String objects from the parcel that was written with writeStringList at the current dataPosition().
Array<T>?

Read and return a new array containing a particular object type from the parcel at the current dataPosition().
ArrayList<T>?

Read and return a new ArrayList containing a particular object type from the parcel that was written with #writeTypedList at the current dataPosition().
ArrayMap<String!, T>?

Read into a new ArrayMap with string keys items containing a particular object type that were written with writeTypedArrayMap(android.util.ArrayMap,int) at the current dataPosition().
SparseArray<T>?

Read into a new SparseArray items containing a particular object type that were written with writeTypedSparseArray(android.util.SparseArray,int) at the current dataPosition().
Int

Returns the amount of data remaining to be read from the parcel.
Int

Returns the total amount of space in the parcel.
Int

Returns the current position in the parcel data.
Int

Returns the total amount of data contained in the parcel.
Unit
enforceInterface(interfaceName: String)

Read the header written by writeInterfaceToken and verify it matches the interface name in question.
Unit

Verify there are no bytes left to be read on the Parcel.
Boolean

Report whether the parcel contains any marshalled file descriptors.
Boolean
hasFileDescriptors(offset: Int, length: Int)

Report whether the parcel contains any marshalled file descriptors in the range defined by offset and length.
ByteArray!

Returns the raw bytes of the parcel.
static Parcel

Retrieve a new Parcel object from the pool.
static Parcel
obtain(binder: IBinder)

Retrieve a new Parcel object from the pool for use with a specific binder.
Array<Any!>?

Read and return a new Object array from the parcel at the current dataPosition().
Array<T>?
readArray(loader: ClassLoader?, clazz: Class<T>)

Same as readArray(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
ArrayList<Any!>?

Read and return a new ArrayList object from the parcel at the current dataPosition().
ArrayList<T>?
readArrayList(loader: ClassLoader?, clazz: Class<out T>)

Same as readArrayList(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
Unit

Unit

Read into the given List items IBinder objects that were written with writeBinderList at the current dataPosition().
ByteArray?

Read a blob of data from the parcel and return it as a byte array.
Boolean

Read a boolean value from the parcel at the current dataPosition().
Unit

Bundle?

Read and return a new Bundle object from the parcel at the current dataPosition().
Bundle?

Read and return a new Bundle object from the parcel at the current dataPosition(), using the given class loader to initialize the class loader of the Bundle for later retrieval of Parcelable objects.
Byte

Read a byte value from the parcel at the current dataPosition().
Unit

Read a byte[] object from the parcel and copy it into the given byte array.
Unit

Double

Read a double precision floating point value from the parcel at the current dataPosition().
Unit

Unit

Special function for reading an exception result from the header of a parcel, to be used after receiving the result of a transaction.
Unit
readException(code: Int, msg: String!)

Throw an exception with the given message.
ParcelFileDescriptor!

Read a FileDescriptor from the parcel at the current dataPosition().
Unit

Read a new multi-dimensional array from a parcel.
Unit
readFixedArray(val: T, asInterface: Function<IBinder!, S>)

Read a new multi-dimensional array of typed interfaces from a parcel.
Unit

Read a new multi-dimensional array of typed parcelables from a parcel.
Float

Read a floating point value from the parcel at the current dataPosition().
Unit

HashMap<Any!, Any!>?

Please use readBundle(java.lang.ClassLoader) instead (whose data must have been written with writeBundle.
HashMap<K, V>?
readHashMap(loader: ClassLoader?, clazzKey: Class<out K>, clazzValue: Class<out V>)

Same as readHashMap(java.lang.ClassLoader) but accepts clazzKey and clazzValue parameter as the types required for each key and value pair.
Int

Read an integer value from the parcel at the current dataPosition().
Unit

Unit
readInterfaceArray(val: Array<T>, asInterface: Function<IBinder!, T>)

Read an array of T (IInterface) from a parcel.
Unit
readInterfaceList(list: MutableList<T>, asInterface: Function<IBinder!, T>)

Read into the given List items IInterface objects that were written with writeInterfaceList at the current dataPosition().
Unit
readList(outVal: MutableList<Any?>, loader: ClassLoader?)

Read into an existing List object from the parcel at the current dataPosition(), using the given class loader to load any enclosed Parcelables.
Unit
readList(outVal: MutableList<in T>, loader: ClassLoader?, clazz: Class<T>)

Same as readList(java.util.List,java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
Long

Read a long integer value from the parcel at the current dataPosition().
Unit

Unit
readMap(outVal: MutableMap<Any?, Any?>, loader: ClassLoader?)

Please use readBundle(java.lang.ClassLoader) instead (whose data must have been written with writeBundle.
Unit
readMap(outVal: MutableMap<in K, in V>, loader: ClassLoader?, clazzKey: Class<K>, clazzValue: Class<V>)

Same as readMap(java.util.Map,java.lang.ClassLoader) but accepts clazzKey and clazzValue parameter as the types required for each key and value pair.
T?

Read and return a new Parcelable from the parcel.
T?
readParcelable(loader: ClassLoader?, clazz: Class<T>)

Same as readParcelable(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
Array<Parcelable!>?

Read and return a new Parcelable array from the parcel.
Array<T>?
readParcelableArray(loader: ClassLoader?, clazz: Class<T>)

Same as readParcelableArray(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
Parcelable.Creator<*>?

Read and return a Parcelable.
Parcelable.Creator<T>?
readParcelableCreator(loader: ClassLoader?, clazz: Class<T>)

Same as readParcelableCreator(java.lang.ClassLoader) but accepts clazz parameter as the required type.
MutableList<T>

Read the list of Parcelable objects at the current data position into the given list.
MutableList<T>
readParcelableList(list: MutableList<T>, cl: ClassLoader?, clazz: Class<out T>)

Same as readParcelableList(java.util.List,java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
PersistableBundle?

Read and return a new Bundle object from the parcel at the current dataPosition().
PersistableBundle?

Read and return a new Bundle object from the parcel at the current dataPosition(), using the given class loader to initialize the class loader of the Bundle for later retrieval of Parcelable objects.
Serializable?

Read and return a new Serializable object from the parcel.
T?
readSerializable(loader: ClassLoader?, clazz: Class<T>)

Same as readSerializable() but accepts loader and clazz parameters.
Size

Read a Size from the parcel at the current dataPosition().
SizeF

Read a SizeF from the parcel at the current dataPosition().
SparseArray<T>?

Read and return a new SparseArray object from the parcel at the current dataPosition().
SparseArray<T>?
readSparseArray(loader: ClassLoader?, clazz: Class<out T>)

Same as readSparseArray(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.
SparseBooleanArray?

Read and return a new SparseBooleanArray object from the parcel at the current dataPosition().
String?

Read a string value from the parcel at the current dataPosition().
Unit

Unit

Read into the given List items String objects that were written with writeStringList at the current dataPosition().
IBinder!

Read an object from the parcel at the current dataPosition().
Unit

Unit

Read into the given List items containing a particular object type that were written with #writeTypedList at the current dataPosition().
T?

Read and return a typed Parcelable object from a parcel.
Any?

Read a typed object from a parcel.
Unit

Put a Parcel object back into the pool.
Unit

Change the capacity (current available space) of the parcel.
Unit

Move the current read/write position in the parcel.
Unit

Change the amount of data in the parcel.
Unit

This method is used by the AIDL compiler for system components.
Unit
unmarshall(data: ByteArray, offset: Int, length: Int)

Fills the raw bytes of this Parcel with the supplied data.
Unit
writeArray(val: Array<Any!>?)

Flatten an Object array into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit

Flatten a List containing IBinder objects into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
Unit

Write a blob of data into the parcel at the current dataPosition, growing dataCapacity if needed.
Unit
writeBlob(b: ByteArray?, offset: Int, len: Int)

Write a blob of data into the parcel at the current dataPosition, growing dataCapacity if needed.
Unit

Write a boolean value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit

Flatten a Bundle into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Write a byte value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Write a byte array into the parcel at the current dataPosition, growing dataCapacity if needed.
Unit
writeByteArray(b: ByteArray?, offset: Int, len: Int)

Write a byte array into the parcel at the current dataPosition, growing dataCapacity if needed.
Unit

Unit

Write a double precision floating point value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit

Special function for writing an exception result at the header of a parcel, to be used when returning an exception from a transaction.
Unit

Write a FileDescriptor into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit
writeFixedArray(val: T?, parcelableFlags: Int, vararg dimensions: Int)

Flatten a homogeneous multi-dimensional array with fixed-size.
Unit

Write a floating point value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit
writeInt(val: Int)

Write an integer value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit

Flatten a homogeneous array containing an IInterface type into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
Unit

Flatten a List containing T (IInterface) objects into this parcel at the current position.
Unit
writeInterfaceToken(interfaceName: String)

Store or read an IBinder interface token in the parcel at the current dataPosition.
Unit

Flatten a List into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Write a long integer value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit
writeMap(val: MutableMap<Any?, Any?>?)

Please use writeBundle instead.
Unit

Special function for writing information at the front of the Parcel indicating that no exception occurred.
Unit
writeParcelable(p: Parcelable?, parcelableFlags: Int)

Flatten the name of the class of the Parcelable and its contents into the parcel.
Unit
writeParcelableArray(value: Array<T>?, parcelableFlags: Int)

Write a heterogeneous array of Parcelable objects into the Parcel.
Unit

Flatten the name of the class of the Parcelable into this Parcel.
Unit
writeParcelableList(val: MutableList<T>?, flags: Int)

Flatten a List containing arbitrary Parcelable objects into this parcel at the current position.
Unit

Flatten a PersistableBundle into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Write a generic serializable object in to a Parcel.
Unit

Flatten a Size into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Flatten a SizeF into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Flatten a generic SparseArray into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit

Write a string value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Unit

Flatten a List containing String objects into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
Unit

Write an object into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit

Write an object into the parcel at the current dataPosition(), growing dataCapacity() if needed.
Unit
writeTypedArray(val: Array<T>?, parcelableFlags: Int)

Flatten a homogeneous array containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
Unit
writeTypedArrayMap(val: ArrayMap<String!, T>?, parcelableFlags: Int)

Flatten an ArrayMap with string keys containing a particular object type into the parcel at the current dataPosition() and growing dataCapacity() if needed.
Unit

Flatten a List containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
Unit
writeTypedList(val: MutableList<T>?, parcelableFlags: Int)

Flatten a List containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
Unit
writeTypedObject(val: T?, parcelableFlags: Int)

Flatten the Parcelable object into the parcel.
Unit
writeTypedSparseArray(val: SparseArray<T>?, parcelableFlags: Int)

Flatten a SparseArray containing a particular object type into the parcel at the current dataPosition() and growing dataCapacity() if needed.
Unit

Flatten a generic object in to a parcel.
Protected methods
Unit

Properties
static Parcelable.Creator<String!>!

Public methods

appendFrom

Added in API level 1
fun appendFrom(
    parcel: Parcel!, 
    offset: Int, 
    length: Int
): Unit

createBinderArray

Added in API level 1
fun createBinderArray(): Array<IBinder!>?
Return
Array<IBinder!>? This value may be null.

createBinderArrayList

Added in API level 1
fun createBinderArrayList(): ArrayList<IBinder!>?

Read and return a new ArrayList containing IBinder objects from the parcel that was written with writeBinderList at the current dataPosition(). Returns null if the previously written list object was null.

Return
ArrayList<IBinder!>? A newly created ArrayList containing strings with the same data as those that were previously written.

See Also

createBooleanArray

Added in API level 1
fun createBooleanArray(): BooleanArray?
Return
BooleanArray? This value may be null.

createByteArray

Added in API level 1
fun createByteArray(): ByteArray?

Read and return a byte[] object from the parcel.

Return
ByteArray? This value may be null.

createCharArray

Added in API level 1
fun createCharArray(): CharArray?
Return
CharArray? This value may be null.

createDoubleArray

Added in API level 1
fun createDoubleArray(): DoubleArray?
Return
DoubleArray? This value may be null.

createFixedArray

Added in API level 33
fun <T : Any!> createFixedArray(
    cls: Class<T>, 
    vararg dimensions: Int
): T?

Read and return a new multi-dimensional array from a parcel. Returns null if the previously written array object is null. If you want to read Parcelable or IInterface values, use createFixedArray(java.lang.Class,android.os.Parcelable.Creator,int[]) or createFixedArray(java.lang.Class,java.util.function.Function,int[]).

Parameters
cls Class<T>: the Class object for the target array type. (e.g. int[][].class) This value cannot be null.
dimensions Int: an array of int representing length of each dimension. This value cannot be null.

createFixedArray

Added in API level 33
fun <T : Any!, S : IInterface!> createFixedArray(
    cls: Class<T>, 
    asInterface: Function<IBinder!, S>, 
    vararg dimensions: Int
): T?

Read and return a new multi-dimensional array of typed interfaces from a parcel. Returns null if the previously written array object is null. If you want to read Parcelable values, use createFixedArray(java.lang.Class,android.os.Parcelable.Creator,int[]). For values of other types use createFixedArray(java.lang.Class,int[]).

Parameters
cls Class<T>: the Class object for the target array type. (e.g. IFoo[][].class) This value cannot be null.
dimensions Int: an array of int representing length of each dimension. This value cannot be null.
asInterface Function<IBinder!, S>: This value cannot be null.

createFixedArray

Added in API level 33
fun <T : Any!, S : Parcelable!> createFixedArray(
    cls: Class<T>, 
    c: Parcelable.Creator<S>, 
    vararg dimensions: Int
): T?

Read and return a new multi-dimensional array of typed parcelables from a parcel. Returns null if the previously written array object is null. If you want to read IInterface values, use createFixedArray(java.lang.Class,java.util.function.Function,int[]). For values of other types use createFixedArray(java.lang.Class,int[]).

Parameters
cls Class<T>: the Class object for the target array type. (e.g. Foo[][].class) This value cannot be null.
dimensions Int: an array of int representing length of each dimension. This value cannot be null.
c Parcelable.Creator<S>: This value cannot be null.

createFloatArray

Added in API level 1
fun createFloatArray(): FloatArray?
Return
FloatArray? This value may be null.

createIntArray

Added in API level 1
fun createIntArray(): IntArray?
Return
IntArray? This value may be null.

createInterfaceArray

Added in API level 33
fun <T : IInterface!> createInterfaceArray(
    newArray: IntFunction<Array<T>!>, 
    asInterface: Function<IBinder!, T>
): Array<T>?

Read and return a new array of T (IInterface) from the parcel.

Parameters
newArray IntFunction<Array<T>!>: a function to create an array of T with a given length This value cannot be null.
asInterface Function<IBinder!, T>: a function to convert IBinder object into T (IInterface) This value cannot be null.
Return
Array<T>? the IInterface array of type T This value may be null.

createInterfaceArrayList

Added in API level 33
fun <T : IInterface!> createInterfaceArrayList(asInterface: Function<IBinder!, T>): ArrayList<T>?

Read and return a new ArrayList containing T (IInterface) objects from the parcel that was written with writeInterfaceList at the current dataPosition(). Returns null if the previously written list object was null.

Parameters
asInterface Function<IBinder!, T>: This value cannot be null.
Return
ArrayList<T>? A newly created ArrayList containing T (IInterface)

createLongArray

Added in API level 1
fun createLongArray(): LongArray?
Return
LongArray? This value may be null.

createStringArray

Added in API level 1
fun createStringArray(): Array<String!>?
Return
Array<String!>? This value may be null.

createStringArrayList

Added in API level 1
fun createStringArrayList(): ArrayList<String!>?

Read and return a new ArrayList containing String objects from the parcel that was written with writeStringList at the current dataPosition(). Returns null if the previously written list object was null.

Return
ArrayList<String!>? A newly created ArrayList containing strings with the same data as those that were previously written.

See Also

createTypedArray

Added in API level 1
fun <T : Any!> createTypedArray(c: Parcelable.Creator<T>): Array<T>?

Read and return a new array containing a particular object type from the parcel at the current dataPosition(). Returns null if the previously written array was null. The array must have previously been written via writeTypedArray with the same object type.

Parameters
c Parcelable.Creator<T>: This value cannot be null.
Return
Array<T>? A newly created array containing objects with the same data as those that were previously written.

See Also

createTypedArrayList

Added in API level 1
fun <T : Any!> createTypedArrayList(c: Parcelable.Creator<T>): ArrayList<T>?

Read and return a new ArrayList containing a particular object type from the parcel that was written with #writeTypedList at the current dataPosition(). Returns null if the previously written list object was null. The list must have previously been written via #writeTypedList with the same object type.

Parameters
c Parcelable.Creator<T>: This value cannot be null.
Return
ArrayList<T>? A newly created ArrayList containing objects with the same data as those that were previously written.

See Also

    createTypedArrayMap

    Added in API level 29
    fun <T : Parcelable!> createTypedArrayMap(creator: Parcelable.Creator<T>): ArrayMap<String!, T>?

    Read into a new ArrayMap with string keys items containing a particular object type that were written with writeTypedArrayMap(android.util.ArrayMap,int) at the current dataPosition(). The list must have previously been written via writeTypedArrayMap(android.util.ArrayMap,int) with the same object type.

    Parameters
    creator Parcelable.Creator<T>: The creator to use when for instantiation. This value cannot be null.
    Return
    ArrayMap<String!, T>? A newly created ArrayMap containing objects with the same data as those that were previously written. This value may be null.

    createTypedSparseArray

    Added in API level 29
    fun <T : Parcelable!> createTypedSparseArray(creator: Parcelable.Creator<T>): SparseArray<T>?

    Read into a new SparseArray items containing a particular object type that were written with writeTypedSparseArray(android.util.SparseArray,int) at the current dataPosition(). The list must have previously been written via writeTypedSparseArray(android.util.SparseArray,int) with the same object type.

    Parameters
    creator Parcelable.Creator<T>: The creator to use when for instantiation. This value cannot be null.
    Return
    SparseArray<T>? A newly created SparseArray containing objects with the same data as those that were previously written. This value may be null.

    dataAvail

    Added in API level 1
    fun dataAvail(): Int

    Returns the amount of data remaining to be read from the parcel. That is, dataSize-dataPosition.

    dataCapacity

    Added in API level 1
    fun dataCapacity(): Int

    Returns the total amount of space in the parcel. This is always >= dataSize. The difference between it and dataSize() is the amount of room left until the parcel needs to re-allocate its data buffer.

    dataPosition

    Added in API level 1
    fun dataPosition(): Int

    Returns the current position in the parcel data. Never more than dataSize.

    dataSize

    Added in API level 1
    fun dataSize(): Int

    Returns the total amount of data contained in the parcel.

    enforceInterface

    Added in API level 1
    fun enforceInterface(interfaceName: String): Unit

    Read the header written by writeInterfaceToken and verify it matches the interface name in question. If the wrong interface type is present, SecurityException is thrown. When used over binder, this exception should propagate to the caller.

    Parameters
    interfaceName String: This value cannot be null.

    enforceNoDataAvail

    Added in API level 33
    fun enforceNoDataAvail(): Unit

    Verify there are no bytes left to be read on the Parcel.

    Exceptions
    android.os.BadParcelableException If the current position hasn't reached the end of the Parcel. When used over binder, this exception should propagate to the caller.

    hasFileDescriptors

    Added in API level 1
    fun hasFileDescriptors(): Boolean

    Report whether the parcel contains any marshalled file descriptors.

    hasFileDescriptors

    Added in API level 33
    fun hasFileDescriptors(
        offset: Int, 
        length: Int
    ): Boolean

    Report whether the parcel contains any marshalled file descriptors in the range defined by offset and length.

    Parameters
    offset Int: The offset from which the range starts. Should be between 0 and dataSize().
    length Int: The length of the range. Should be between 0 and dataSize() - offset.
    Return
    Boolean whether there are file descriptors or not.
    Exceptions
    java.lang.IllegalArgumentException if the parameters are out of the permitted ranges.

    marshall

    Added in API level 1
    fun marshall(): ByteArray!

    Returns the raw bytes of the parcel.

    The data you retrieve here must not be placed in any kind of persistent storage (on local disk, across a network, etc). For that, you should use standard serialization or another kind of general serialization mechanism. The Parcel marshalled representation is highly optimized for local IPC, and as such does not attempt to maintain compatibility with data created in different versions of the platform.

    obtain

    Added in API level 1
    static fun obtain(): Parcel

    Retrieve a new Parcel object from the pool.

    Return
    Parcel This value cannot be null.

    obtain

    Added in API level 33
    static fun obtain(binder: IBinder): Parcel

    Retrieve a new Parcel object from the pool for use with a specific binder. Associate this parcel with a binder object. This marks the parcel as being prepared for a transaction on this specific binder object. Based on this, the format of the wire binder protocol may change. For future compatibility, it is recommended to use this for all Parcels.

    Parameters
    binder IBinder: This value cannot be null.
    Return
    Parcel This value cannot be null.

    readArray

    Added in API level 1
    Deprecated in API level 33
    fun readArray(loader: ClassLoader?): Array<Any!>?

    Deprecated: Use the type-safer version readArray(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use createTypedArray(android.os.Parcelable.Creator) if possible (eg. if the items' class is final) since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read and return a new Object array from the parcel at the current dataPosition(). Returns null if the previously written array was null. The given class loader will be used to load any enclosed Parcelables.

    Parameters
    loader ClassLoader?: This value may be null.

    readArray

    Added in API level 33
    fun <T : Any!> readArray(
        loader: ClassLoader?, 
        clazz: Class<T>
    ): Array<T>?

    Same as readArray(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readArray(java.lang.ClassLoader) instead.

    Parameters
    loader ClassLoader?: This value may be null.
    clazz Class<T>: This value cannot be null.
    Return
    Array<T>? This value may be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readArrayList

    Added in API level 1
    Deprecated in API level 33
    fun readArrayList(loader: ClassLoader?): ArrayList<Any!>?

    Deprecated: Use the type-safer version readArrayList(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use createTypedArrayList(android.os.Parcelable.Creator) if possible (eg. if the items' class is final) since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read and return a new ArrayList object from the parcel at the current dataPosition(). Returns null if the previously written list object was null. The given class loader will be used to load any enclosed Parcelables.

    Parameters
    loader ClassLoader?: This value may be null.

    readArrayList

    Added in API level 33
    fun <T : Any!> readArrayList(
        loader: ClassLoader?, 
        clazz: Class<out T>
    ): ArrayList<T>?

    Same as readArrayList(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readArrayList(java.lang.ClassLoader) instead.

    Parameters
    loader ClassLoader?: This value may be null.
    clazz Class<out T>: This value cannot be null.
    Return
    ArrayList<T>? This value may be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readBinderArray

    Added in API level 1
    fun readBinderArray(val: Array<IBinder!>): Unit
    Parameters
    val Array<IBinder!>: This value cannot be null.

    readBinderList

    Added in API level 1
    fun readBinderList(list: MutableList<IBinder!>): Unit

    Read into the given List items IBinder objects that were written with writeBinderList at the current dataPosition().

    Parameters
    list MutableList<IBinder!>: This value cannot be null.

    See Also

    readBlob

    Added in API level 33
    fun readBlob(): ByteArray?

    Read a blob of data from the parcel and return it as a byte array.

    Return
    ByteArray? This value may be null.

    readBoolean

    Added in API level 29
    fun readBoolean(): Boolean

    Read a boolean value from the parcel at the current dataPosition().

    readBooleanArray

    Added in API level 1
    fun readBooleanArray(val: BooleanArray): Unit
    Parameters
    val BooleanArray: This value cannot be null.

    readBundle

    Added in API level 1
    fun readBundle(): Bundle?

    Read and return a new Bundle object from the parcel at the current dataPosition(). Returns null if the previously written Bundle object was null.

    readBundle

    Added in API level 1
    fun readBundle(loader: ClassLoader?): Bundle?

    Read and return a new Bundle object from the parcel at the current dataPosition(), using the given class loader to initialize the class loader of the Bundle for later retrieval of Parcelable objects. Returns null if the previously written Bundle object was null.

    Parameters
    loader ClassLoader?: This value may be null.

    readByte

    Added in API level 1
    fun readByte(): Byte

    Read a byte value from the parcel at the current dataPosition().

    readByteArray

    Added in API level 1
    fun readByteArray(val: ByteArray): Unit

    Read a byte[] object from the parcel and copy it into the given byte array.

    Parameters
    val ByteArray: This value cannot be null.

    readCharArray

    Added in API level 1
    fun readCharArray(val: CharArray): Unit
    Parameters
    val CharArray: This value cannot be null.

    readDouble

    Added in API level 1
    fun readDouble(): Double

    Read a double precision floating point value from the parcel at the current dataPosition().

    readDoubleArray

    Added in API level 1
    fun readDoubleArray(val: DoubleArray): Unit
    Parameters
    val DoubleArray: This value cannot be null.

    readException

    Added in API level 1
    fun readException(): Unit

    Special function for reading an exception result from the header of a parcel, to be used after receiving the result of a transaction. This will throw the exception for you if it had been written to the Parcel, otherwise return and let you read the normal result data from the Parcel.

    readException

    Added in API level 1
    fun readException(
        code: Int, 
        msg: String!
    ): Unit

    Throw an exception with the given message. Not intended for use outside the Parcel class.

    Parameters
    code Int: Used to determine which exception class to throw.
    msg String!: The exception message.

    readFileDescriptor

    Added in API level 1
    fun readFileDescriptor(): ParcelFileDescriptor!

    Read a FileDescriptor from the parcel at the current dataPosition().

    readFixedArray

    Added in API level 33
    fun <T : Any!> readFixedArray(val: T): Unit

    Read a new multi-dimensional array from a parcel. If you want to read Parcelable or IInterface values, use readFixedArray(java.lang.Object,android.os.Parcelable.Creator) or readFixedArray(java.lang.Object,java.util.function.Function).

    Parameters
    val T: the destination array to hold the read values. This value cannot be null.

    readFixedArray

    Added in API level 33
    fun <T : Any!, S : IInterface!> readFixedArray(
        val: T, 
        asInterface: Function<IBinder!, S>
    ): Unit

    Read a new multi-dimensional array of typed interfaces from a parcel. If you want to read Parcelable values, use readFixedArray(java.lang.Object,android.os.Parcelable.Creator). For values of other types, use readFixedArray(java.lang.Object).

    Parameters
    val T: the destination array to hold the read values. This value cannot be null.
    asInterface Function<IBinder!, S>: This value cannot be null.

    readFixedArray

    Added in API level 33
    fun <T : Any!, S : Parcelable!> readFixedArray(
        val: T, 
        c: Parcelable.Creator<S>
    ): Unit

    Read a new multi-dimensional array of typed parcelables from a parcel. If you want to read IInterface values, use readFixedArray(java.lang.Object,java.util.function.Function). For values of other types, use readFixedArray(java.lang.Object).

    Parameters
    val T: the destination array to hold the read values. This value cannot be null.
    c Parcelable.Creator<S>: This value cannot be null.

    readFloat

    Added in API level 1
    fun readFloat(): Float

    Read a floating point value from the parcel at the current dataPosition().

    readFloatArray

    Added in API level 1
    fun readFloatArray(val: FloatArray): Unit
    Parameters
    val FloatArray: This value cannot be null.

    readHashMap

    Added in API level 1
    Deprecated in API level 33
    fun readHashMap(loader: ClassLoader?): HashMap<Any!, Any!>?

    Deprecated: Consider using readBundle(java.lang.ClassLoader) as stated above, in case this method is still preferred use the type-safer version readHashMap(java.lang.ClassLoader,java.lang.Class,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU.

    Please use readBundle(java.lang.ClassLoader) instead (whose data must have been written with writeBundle. Read and return a new HashMap object from the parcel at the current dataPosition(), using the given class loader to load any enclosed Parcelables. Returns null if the previously written map object was null.

    Parameters
    loader ClassLoader?: This value may be null.

    readHashMap

    Added in API level 33
    fun <K : Any!, V : Any!> readHashMap(
        loader: ClassLoader?, 
        clazzKey: Class<out K>, 
        clazzValue: Class<out V>
    ): HashMap<K, V>?

    Same as readHashMap(java.lang.ClassLoader) but accepts clazzKey and clazzValue parameter as the types required for each key and value pair.

    Parameters
    loader ClassLoader?: This value may be null.
    clazzKey Class<out K>: This value cannot be null.
    clazzValue Class<out V>: This value cannot be null.
    Return
    HashMap<K, V>? This value may be null.
    Exceptions
    android.os.BadParcelableException if the item to be deserialized is not an instance of that class or any of its children class

    readInt

    Added in API level 1
    fun readInt(): Int

    Read an integer value from the parcel at the current dataPosition().

    readIntArray

    Added in API level 1
    fun readIntArray(val: IntArray): Unit
    Parameters
    val IntArray: This value cannot be null.

    readInterfaceArray

    Added in API level 33
    fun <T : IInterface!> readInterfaceArray(
        val: Array<T>, 
        asInterface: Function<IBinder!, T>
    ): Unit

    Read an array of T (IInterface) from a parcel.

    Parameters
    asInterface Function<IBinder!, T>: a function to convert IBinder object into T (IInterface) This value cannot be null.
    val Array<T>: This value cannot be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the length of `val` mismatches the number of items in the parcel.

    readInterfaceList

    Added in API level 33
    fun <T : IInterface!> readInterfaceList(
        list: MutableList<T>, 
        asInterface: Function<IBinder!, T>
    ): Unit

    Read into the given List items IInterface objects that were written with writeInterfaceList at the current dataPosition().

    Parameters
    list MutableList<T>: This value cannot be null.
    asInterface Function<IBinder!, T>: This value cannot be null.

    readList

    Added in API level 1
    Deprecated in API level 33
    fun readList(
        outVal: MutableList<Any?>, 
        loader: ClassLoader?
    ): Unit

    Deprecated: Use the type-safer version readList(java.util.List,java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use readTypedList(java.util.List,android.os.Parcelable.Creator) if possible (eg. if the items' class is final) since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read into an existing List object from the parcel at the current dataPosition(), using the given class loader to load any enclosed Parcelables. If it is null, the default class loader is used.

    Parameters
    outVal MutableList<Any?>: This value cannot be null.
    loader ClassLoader?: This value may be null.

    readList

    Added in API level 33
    fun <T : Any!> readList(
        outVal: MutableList<in T>, 
        loader: ClassLoader?, 
        clazz: Class<T>
    ): Unit

    Same as readList(java.util.List,java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readList(java.util.List,java.lang.ClassLoader) instead.

    Parameters
    outVal MutableList<in T>: This value cannot be null.
    loader ClassLoader?: This value may be null.
    clazz Class<T>: This value cannot be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readLong

    Added in API level 1
    fun readLong(): Long

    Read a long integer value from the parcel at the current dataPosition().

    readLongArray

    Added in API level 1
    fun readLongArray(val: LongArray): Unit
    Parameters
    val LongArray: This value cannot be null.

    readMap

    Added in API level 1
    Deprecated in API level 33
    fun readMap(
        outVal: MutableMap<Any?, Any?>, 
        loader: ClassLoader?
    ): Unit

    Deprecated: Consider using readBundle(java.lang.ClassLoader) as stated above, in case this method is still preferred use the type-safer version readMap(java.util.Map,java.lang.ClassLoader,java.lang.Class,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU.

    Please use readBundle(java.lang.ClassLoader) instead (whose data must have been written with writeBundle. Read into an existing Map object from the parcel at the current dataPosition().

    Parameters
    outVal MutableMap<Any?, Any?>: This value cannot be null.
    loader ClassLoader?: This value may be null.

    readMap

    Added in API level 33
    fun <K : Any!, V : Any!> readMap(
        outVal: MutableMap<in K, in V>, 
        loader: ClassLoader?, 
        clazzKey: Class<K>, 
        clazzValue: Class<V>
    ): Unit

    Same as readMap(java.util.Map,java.lang.ClassLoader) but accepts clazzKey and clazzValue parameter as the types required for each key and value pair.

    Parameters
    outVal MutableMap<in K, in V>: This value cannot be null.
    loader ClassLoader?: This value may be null.
    clazzKey Class<K>: This value cannot be null.
    clazzValue Class<V>: This value cannot be null.
    Exceptions
    android.os.BadParcelableException If the item to be deserialized is not an instance of that class or any of its children class

    readParcelable

    Added in API level 1
    Deprecated in API level 33
    fun <T : Parcelable!> readParcelable(loader: ClassLoader?): T?

    Deprecated: Use the type-safer version readParcelable(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use Parcelable.Creator#createFromParcel(Parcel) if possible since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read and return a new Parcelable from the parcel. The given class loader will be used to load any enclosed Parcelables. If it is null, the default class loader will be used.

    Parameters
    loader ClassLoader?: A ClassLoader from which to instantiate the Parcelable object, or null for the default class loader.
    Return
    T? Returns the newly created Parcelable, or null if a null object has been written.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if there was an error trying to instantiate the Parcelable.

    readParcelable

    Added in API level 33
    fun <T : Any!> readParcelable(
        loader: ClassLoader?, 
        clazz: Class<T>
    ): T?

    Same as readParcelable(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readParcelable(java.lang.ClassLoader) instead.

    Parameters
    loader ClassLoader?: This value may be null.
    clazz Class<T>: This value cannot be null.
    Return
    T? This value may be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readParcelableArray

    Added in API level 1
    Deprecated in API level 33
    fun readParcelableArray(loader: ClassLoader?): Array<Parcelable!>?

    Deprecated: Use the type-safer version readParcelableArray(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use createTypedArray(android.os.Parcelable.Creator) if possible (eg. if the items' class is final) since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read and return a new Parcelable array from the parcel. The given class loader will be used to load any enclosed Parcelables.

    Parameters
    loader ClassLoader?: This value may be null.
    Return
    Array<Parcelable!>? the Parcelable array, or null if the array is null

    readParcelableArray

    Added in API level 33
    fun <T : Any!> readParcelableArray(
        loader: ClassLoader?, 
        clazz: Class<T>
    ): Array<T>?

    Same as readParcelableArray(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readParcelableArray(java.lang.ClassLoader) instead.

    Parameters
    loader ClassLoader?: This value may be null.
    clazz Class<T>: This value cannot be null.
    Return
    Array<T>? This value may be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readParcelableCreator

    Added in API level 30
    Deprecated in API level 33
    fun readParcelableCreator(loader: ClassLoader?): Parcelable.Creator<*>?

    Deprecated: Use the type-safer version readParcelableCreator(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU.

    Read and return a Parcelable.Creator from the parcel. The given class loader will be used to load the Parcelable.Creator. If it is null, the default class loader will be used.

    Parameters
    loader ClassLoader?: A ClassLoader from which to instantiate the Parcelable.Creator object, or null for the default class loader.
    Return
    Parcelable.Creator<*>? the previously written Parcelable.Creator, or null if a null Creator was written.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if there was an error trying to read the Parcelable.Creator.

    readParcelableCreator

    fun <T : Any!> readParcelableCreator(
        loader: ClassLoader?, 
        clazz: Class<T>
    ): Parcelable.Creator<T>?

    Same as readParcelableCreator(java.lang.ClassLoader) but accepts clazz parameter as the required type.

    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 instead.

    readParcelableList

    Added in API level 29
    Deprecated in API level 33
    fun <T : Parcelable!> readParcelableList(
        list: MutableList<T>, 
        cl: ClassLoader?
    ): MutableList<T>

    Deprecated: Use the type-safer version readParcelableList(java.util.List,java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use readTypedList(java.util.List,android.os.Parcelable.Creator) if possible (eg. if the items' class is final) since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read the list of Parcelable objects at the current data position into the given list. The contents of the list are replaced. If the serialized list was null, list is cleared.

    Parameters
    list MutableList<T>: This value cannot be null.
    cl ClassLoader?: This value may be null.

    readParcelableList

    Added in API level 33
    fun <T : Any!> readParcelableList(
        list: MutableList<T>, 
        cl: ClassLoader?, 
        clazz: Class<out T>
    ): MutableList<T>

    Same as readParcelableList(java.util.List,java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readParcelableList(java.util.List,java.lang.ClassLoader) instead.

    Parameters
    list MutableList<T>: This value cannot be null.
    cl ClassLoader?: This value may be null.
    clazz Class<out T>: This value cannot be null.
    Return
    MutableList<T> This value cannot be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readPersistableBundle

    Added in API level 21
    fun readPersistableBundle(): PersistableBundle?

    Read and return a new Bundle object from the parcel at the current dataPosition(). Returns null if the previously written Bundle object was null.

    readPersistableBundle

    Added in API level 21
    fun readPersistableBundle(loader: ClassLoader?): PersistableBundle?

    Read and return a new Bundle object from the parcel at the current dataPosition(), using the given class loader to initialize the class loader of the Bundle for later retrieval of Parcelable objects. Returns null if the previously written Bundle object was null.

    Parameters
    loader ClassLoader?: This value may be null.

    readSerializable

    Added in API level 1
    Deprecated in API level 33
    fun readSerializable(): Serializable?

    Deprecated: Use the type-safer version readSerializable(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU.

    Read and return a new Serializable object from the parcel.

    Return
    Serializable? the Serializable object, or null if the Serializable name wasn't found in the parcel. Unlike readSerializable(java.lang.ClassLoader,java.lang.Class), it uses the nearest valid class loader up the execution stack to instantiate the Serializable object.

    readSerializable

    Added in API level 33
    fun <T : Any!> readSerializable(
        loader: ClassLoader?, 
        clazz: Class<T>
    ): T?

    Same as readSerializable() but accepts loader and clazz parameters.

    Parameters
    loader ClassLoader?: A ClassLoader from which to instantiate the Serializable object, or null for the default class loader.
    clazz Class<T>: The type of the object expected. This value cannot be null.
    Return
    T? This value may be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children class or there there was an error deserializing the object.

    readSize

    Added in API level 21
    fun readSize(): Size

    Read a Size from the parcel at the current dataPosition().

    Return
    Size This value cannot be null.

    readSizeF

    Added in API level 21
    fun readSizeF(): SizeF

    Read a SizeF from the parcel at the current dataPosition().

    Return
    SizeF This value cannot be null.

    readSparseArray

    Added in API level 1
    Deprecated in API level 33
    fun <T : Any!> readSparseArray(loader: ClassLoader?): SparseArray<T>?

    Deprecated: Use the type-safer version readSparseArray(java.lang.ClassLoader,java.lang.Class) starting from Android Build.VERSION_CODES#TIRAMISU. Also consider changing the format to use createTypedSparseArray(android.os.Parcelable.Creator) if possible (eg. if the items' class is final) since this is also more performant. Note that changing to the latter also requires changing the writes.

    Read and return a new SparseArray object from the parcel at the current dataPosition(). Returns null if the previously written list object was null. The given class loader will be used to load any enclosed Parcelables.

    Parameters
    loader ClassLoader?: This value may be null.

    readSparseArray

    Added in API level 33
    fun <T : Any!> readSparseArray(
        loader: ClassLoader?, 
        clazz: Class<out T>
    ): SparseArray<T>?

    Same as readSparseArray(java.lang.ClassLoader) but accepts clazz parameter as the type required for each item.

    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 readSparseArray(java.lang.ClassLoader) instead.

    Parameters
    loader ClassLoader?: This value may be null.
    clazz Class<out T>: This value cannot be null.
    Return
    SparseArray<T>? This value may be null.
    Exceptions
    android.os.BadParcelableException Throws BadParcelableException if the item to be deserialized is not an instance of that class or any of its children classes or there was an error trying to instantiate an element.

    readSparseBooleanArray

    Added in API level 1
    fun readSparseBooleanArray(): SparseBooleanArray?

    Read and return a new SparseBooleanArray object from the parcel at the current dataPosition(). Returns null if the previously written list object was null.

    readString

    Added in API level 1
    fun readString(): String?

    Read a string value from the parcel at the current dataPosition().

    Return
    String? This value may be null.

    readStringArray

    Added in API level 1
    fun readStringArray(val: Array<String!>): Unit
    Parameters
    val Array<String!>: This value cannot be null.

    readStringList

    Added in API level 1
    fun readStringList(list: MutableList<String!>): Unit

    Read into the given List items String objects that were written with writeStringList at the current dataPosition().

    Parameters
    list MutableList<String!>: This value cannot be null.

    See Also

    readStrongBinder

    Added in API level 1
    fun readStrongBinder(): IBinder!

    Read an object from the parcel at the current dataPosition().

    readTypedArray

    Added in API level 1
    fun <T : Any!> readTypedArray(
        val: Array<T>, 
        c: Parcelable.Creator<T>
    ): Unit
    Parameters
    val Array<T>: This value cannot be null.
    c Parcelable.Creator<T>: This value cannot be null.

    readTypedList

    Added in API level 1
    fun <T : Any!> readTypedList(
        list: MutableList<T>, 
        c: Parcelable.Creator<T>
    ): Unit

    Read into the given List items containing a particular object type that were written with #writeTypedList at the current dataPosition(). The list must have previously been written via #writeTypedList with the same object type.

    Parameters
    list MutableList<T>: This value cannot be null.
    c Parcelable.Creator<T>: This value cannot be null.

    See Also

      readTypedObject

      Added in API level 23
      fun <T : Any!> readTypedObject(c: Parcelable.Creator<T>): T?

      Read and return a typed Parcelable object from a parcel. Returns null if the previous written object was null. The object must have previous been written via writeTypedObject with the same object type.

      Parameters
      c Parcelable.Creator<T>: This value cannot be null.
      Return
      T? A newly created object of the type that was previously written.

      readValue

      Added in API level 1
      fun readValue(loader: ClassLoader?): Any?

      Read a typed object from a parcel. The given class loader will be used to load any enclosed Parcelables. If it is null, the default class loader will be used.

      Parameters
      loader ClassLoader?: This value may be null.

      recycle

      Added in API level 1
      fun recycle(): Unit

      Put a Parcel object back into the pool. You must not touch the object after this call.

      setDataCapacity

      Added in API level 1
      fun setDataCapacity(size: Int): Unit

      Change the capacity (current available space) of the parcel.

      Parameters
      size Int: The new capacity of the parcel, in bytes. Can not be less than dataSize -- that is, you can not drop existing data with this method.

      setDataPosition

      Added in API level 1
      fun setDataPosition(pos: Int): Unit

      Move the current read/write position in the parcel.

      Parameters
      pos Int: New offset in the parcel; must be between 0 and dataSize.

      setDataSize

      Added in API level 1
      fun setDataSize(size: Int): Unit

      Change the amount of data in the parcel. Can be either smaller or larger than the current size. If larger than the current capacity, more memory will be allocated.

      Parameters
      size Int: The new number of bytes in the Parcel.

      setPropagateAllowBlocking

      Added in API level 33
      fun setPropagateAllowBlocking(): Unit

      This method is used by the AIDL compiler for system components. Not intended to be used by non-system apps.

      unmarshall

      Added in API level 1
      fun unmarshall(
          data: ByteArray, 
          offset: Int, 
          length: Int
      ): Unit

      Fills the raw bytes of this Parcel with the supplied data.

      Parameters
      data ByteArray: This value cannot be null.

      writeArray

      Added in API level 1
      fun writeArray(val: Array<Any!>?): Unit

      Flatten an Object array into the parcel at the current dataPosition(), growing dataCapacity() if needed. The array values are written using writeValue and must follow the specification there.

      Parameters
      val Array<Any!>?: This value may be null.

      writeBinderArray

      Added in API level 1
      fun writeBinderArray(val: Array<IBinder!>?): Unit
      Parameters
      val Array<IBinder!>?: This value may be null.

      writeBinderList

      Added in API level 1
      fun writeBinderList(val: MutableList<IBinder!>?): Unit

      Flatten a List containing IBinder objects into the parcel, at the current dataPosition() and growing dataCapacity() if needed. They can later be retrieved with createBinderArrayList or readBinderList.

      Parameters
      val MutableList<IBinder!>?: The list of strings to be written. This value may be null.

      writeBlob

      Added in API level 33
      fun writeBlob(b: ByteArray?): Unit

      Write a blob of data into the parcel at the current dataPosition, growing dataCapacity if needed.

      If the blob is small, then it is stored in-place, otherwise it is transferred by way of an anonymous shared memory region. If you prefer send in-place, please use writeByteArray(byte[]).

      Parameters
      b ByteArray?: Bytes to place into the parcel. This value may be null.

      See Also

      writeBlob

      Added in API level 33
      fun writeBlob(
          b: ByteArray?, 
          offset: Int, 
          len: Int
      ): Unit

      Write a blob of data into the parcel at the current dataPosition, growing dataCapacity if needed.

      If the blob is small, then it is stored in-place, otherwise it is transferred by way of an anonymous shared memory region. If you prefer send in-place, please use writeByteArray(byte[],int,int).

      Parameters
      b ByteArray?: Bytes to place into the parcel. This value may be null.
      offset Int: Index of first byte to be written.
      len Int: Number of bytes to write.

      See Also

      writeBoolean

      Added in API level 29
      fun writeBoolean(val: Boolean): Unit

      Write a boolean value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      Note: This method currently delegates to writeInt with a value of 1 or 0 for true or false, respectively, but may change in the future.

      writeBooleanArray

      Added in API level 1
      fun writeBooleanArray(val: BooleanArray?): Unit
      Parameters
      val BooleanArray?: This value may be null.

      writeBundle

      Added in API level 1
      fun writeBundle(val: Bundle?): Unit

      Flatten a Bundle into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      Parameters
      val Bundle?: This value may be null.

      writeByte

      Added in API level 1
      fun writeByte(val: Byte): Unit

      Write a byte value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      Note: This method currently delegates to writeInt but may change in the future.

      writeByteArray

      Added in API level 1
      fun writeByteArray(b: ByteArray?): Unit

      Write a byte array into the parcel at the current dataPosition, growing dataCapacity if needed.

      Parameters
      b ByteArray?: Bytes to place into the parcel. This value may be null.

      writeByteArray

      Added in API level 1
      fun writeByteArray(
          b: ByteArray?, 
          offset: Int, 
          len: Int
      ): Unit

      Write a byte array into the parcel at the current dataPosition, growing dataCapacity if needed.

      Parameters
      b ByteArray?: Bytes to place into the parcel. This value may be null.
      offset Int: Index of first byte to be written.
      len Int: Number of bytes to write.

      writeCharArray

      Added in API level 1
      fun writeCharArray(val: CharArray?): Unit
      Parameters
      val CharArray?: This value may be null.

      writeDouble

      Added in API level 1
      fun writeDouble(val: Double): Unit

      Write a double precision floating point value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      writeDoubleArray

      Added in API level 1
      fun writeDoubleArray(val: DoubleArray?): Unit
      Parameters
      val DoubleArray?: This value may be null.

      writeException

      Added in API level 1
      fun writeException(e: Exception): Unit

      Special function for writing an exception result at the header of a parcel, to be used when returning an exception from a transaction. Note that this currently only supports a few exception types; any other exception will be re-thrown by this function as a RuntimeException (to be caught by the system's last-resort exception handling when dispatching a transaction).

      The supported exception types are:

      Parameters
      e Exception: The Exception to be written. This value cannot be null.

      writeFileDescriptor

      Added in API level 1
      fun writeFileDescriptor(val: FileDescriptor): Unit

      Write a FileDescriptor into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      The file descriptor will not be closed, which may result in file descriptor leaks when objects are returned from Binder calls. Use ParcelFileDescriptor#writeToParcel instead, which accepts contextual flags and will close the original file descriptor if Parcelable#PARCELABLE_WRITE_RETURN_VALUE is set.

      Parameters
      val FileDescriptor: This value cannot be null.

      writeFixedArray

      Added in API level 33
      fun <T : Any!> writeFixedArray(
          val: T?, 
          parcelableFlags: Int, 
          vararg dimensions: Int
      ): Unit

      Flatten a homogeneous multi-dimensional array with fixed-size. This delegates to other APIs to write a one-dimensional array. Use readFixedArray(java.lang.Object) or createFixedArray(java.lang.Class,int[]) with the same dimensions to unmarshal.

      Parameters
      val T?: The array to be written. This value may be null.
      parcelableFlags Int: Contextual flags as per Parcelable.writeToParcel(). Used only if val is an array of Parcelable objects.
      dimensions Int: an array of int representing length of each dimension. The array should be sized with the exact size of dimensions. This value cannot be null.
      Exceptions
      android.os.BadParcelableException If the array's component type is not supported or if its size doesn't match with the given dimensions.

      writeFloat

      Added in API level 1
      fun writeFloat(val: Float): Unit

      Write a floating point value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      writeFloatArray

      Added in API level 1
      fun writeFloatArray(val: FloatArray?): Unit
      Parameters
      val FloatArray?: This value may be null.

      writeInt

      Added in API level 1
      fun writeInt(val: Int): Unit

      Write an integer value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      writeIntArray

      Added in API level 1
      fun writeIntArray(val: IntArray?): Unit
      Parameters
      val IntArray?: This value may be null.

      writeInterfaceArray

      Added in API level 33
      fun <T : IInterface!> writeInterfaceArray(val: Array<T>?): Unit

      Flatten a homogeneous array containing an IInterface type into the parcel, at the current dataPosition() and growing dataCapacity() if needed. The type of the objects in the array must be one that implements IInterface.

      Parameters
      val Array<T>?: The array of objects to be written. This value may be null.

      writeInterfaceList

      Added in API level 33
      fun <T : IInterface!> writeInterfaceList(val: MutableList<T>?): Unit

      Flatten a List containing T (IInterface) objects into this parcel at the current position. They can later be retrieved with createInterfaceArrayList or readInterfaceList.

      Parameters
      val MutableList<T>?: This value may be null.

      writeInterfaceToken

      Added in API level 1
      fun writeInterfaceToken(interfaceName: String): Unit

      Store or read an IBinder interface token in the parcel at the current dataPosition. This is used to validate that the marshalled transaction is intended for the target interface. This is typically written at the beginning of transactions as a header.

      Parameters
      interfaceName String: This value cannot be null.

      writeList

      Added in API level 1
      fun writeList(val: MutableList<Any?>?): Unit

      Flatten a List into the parcel at the current dataPosition(), growing dataCapacity() if needed. The List values are written using writeValue and must follow the specification there.

      Parameters
      val MutableList<Any?>?: This value may be null.

      writeLong

      Added in API level 1
      fun writeLong(val: Long): Unit

      Write a long integer value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

      writeLongArray

      Added in API level 1
      fun writeLongArray(val: LongArray?): Unit
      Parameters
      val LongArray?: This value may be null.

      writeMap

      Added in API level 1
      fun writeMap(val: MutableMap<Any?, Any?>?): Unit

      Please use writeBundle instead. Flattens a Map into the parcel at the current dataPosition(), growing dataCapacity() if needed. The Map keys must be String objects. The Map values are written using writeValue and must follow the specification there.

      It is strongly recommended to use writeBundle instead of this method, since the Bundle class provides a type-safe API that allows you to avoid mysterious type errors at the point of marshalling.

      Parameters
      val MutableMap<Any?, Any?>?: This value may be null.

      writeNoException

      Added in API level 1
      fun writeNoException(): Unit

      Special function for writing information at the front of the Parcel indicating that no exception occurred.

      See Also

      writeParcelable

      Added in API level 1
      fun writeParcelable(
          p: Parcelable?, 
          parcelableFlags: Int
      ): Unit

      Flatten the name of the class of the Parcelable and its contents into the parcel.

      Parameters
      p Parcelable?: The Parcelable object to be written. This value may be null.
      parcelableFlags Int: Contextual flags as per Parcelable.writeToParcel().

      writeParcelableArray

      Added in API level 1
      fun <T : Parcelable!> writeParcelableArray(
          value: Array<T>?, 
          parcelableFlags: Int
      ): Unit

      Write a heterogeneous array of Parcelable objects into the Parcel. Each object in the array is written along with its class name, so that the correct class can later be instantiated. As a result, this has significantly more overhead than writeTypedArray, but will correctly handle an array containing more than one type of object.

      Parameters
      value Array<T>?: The array of objects to be written. This value may be null.
      parcelableFlags Int: Contextual flags as per Parcelable.writeToParcel().

      See Also

      writeParcelableCreator

      Added in API level 30
      fun writeParcelableCreator(p: Parcelable): Unit

      Flatten the name of the class of the Parcelable into this Parcel.

      Parameters
      p Parcelable: The Parcelable object to be written. This value cannot be null.

      See Also

        writeParcelableList

        Added in API level 29
        fun <T : Parcelable!> writeParcelableList(
            val: MutableList<T>?, 
            flags: Int
        ): Unit

        Flatten a List containing arbitrary Parcelable objects into this parcel at the current position. They can later be retrieved using readParcelableList(java.util.List,java.lang.ClassLoader) if required.

        Parameters
        val MutableList<T>?: This value may be null.

        writePersistableBundle

        Added in API level 21
        fun writePersistableBundle(val: PersistableBundle?): Unit

        Flatten a PersistableBundle into the parcel at the current dataPosition(), growing dataCapacity() if needed.

        Parameters
        val PersistableBundle?: This value may be null.

        writeSerializable

        Added in API level 1
        fun writeSerializable(s: Serializable?): Unit

        Write a generic serializable object in to a Parcel. It is strongly recommended that this method be avoided, since the serialization overhead is extremely large, and this approach will be much slower than using the other approaches to writing data in to a Parcel.

        Parameters
        s Serializable?: This value may be null.

        writeSize

        Added in API level 21
        fun writeSize(val: Size): Unit

        Flatten a Size into the parcel at the current dataPosition(), growing dataCapacity() if needed.

        Parameters
        val Size: This value cannot be null.

        writeSizeF

        Added in API level 21
        fun writeSizeF(val: SizeF): Unit

        Flatten a SizeF into the parcel at the current dataPosition(), growing dataCapacity() if needed.

        Parameters
        val SizeF: This value cannot be null.

        writeSparseArray

        Added in API level 1
        fun <T : Any!> writeSparseArray(val: SparseArray<T>?): Unit

        Flatten a generic SparseArray into the parcel at the current dataPosition(), growing dataCapacity() if needed. The SparseArray values are written using writeValue and must follow the specification there.

        Parameters
        val SparseArray<T>?: This value may be null.

        writeSparseBooleanArray

        Added in API level 1
        fun writeSparseBooleanArray(val: SparseBooleanArray?): Unit
        Parameters
        val SparseBooleanArray?: This value may be null.

        writeString

        Added in API level 1
        fun writeString(val: String?): Unit

        Write a string value into the parcel at the current dataPosition(), growing dataCapacity() if needed.

        Parameters
        val String?: This value may be null.

        writeStringArray

        Added in API level 1
        fun writeStringArray(val: Array<String!>?): Unit
        Parameters
        val Array<String!>?: This value may be null.

        writeStringList

        Added in API level 1
        fun writeStringList(val: MutableList<String!>?): Unit

        Flatten a List containing String objects into the parcel, at the current dataPosition() and growing dataCapacity() if needed. They can later be retrieved with createStringArrayList or readStringList.

        Parameters
        val MutableList<String!>?: The list of strings to be written. This value may be null.

        writeStrongBinder

        Added in API level 1
        fun writeStrongBinder(val: IBinder!): Unit

        Write an object into the parcel at the current dataPosition(), growing dataCapacity() if needed.

        writeStrongInterface

        Added in API level 1
        fun writeStrongInterface(val: IInterface!): Unit

        Write an object into the parcel at the current dataPosition(), growing dataCapacity() if needed.

        writeTypedArray

        Added in API level 1
        fun <T : Parcelable!> writeTypedArray(
            val: Array<T>?, 
            parcelableFlags: Int
        ): Unit

        Flatten a homogeneous array containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed. The type of the objects in the array must be one that implements Parcelable. Unlike the writeParcelableArray method, however, only the raw data of the objects is written and not their type, so you must use readTypedArray with the correct corresponding Parcelable.Creator implementation to unmarshall them.

        Parameters
        val Array<T>?: The array of objects to be written. This value may be null.
        parcelableFlags Int: Contextual flags as per Parcelable.writeToParcel().

        writeTypedArrayMap

        Added in API level 29
        fun <T : Parcelable!> writeTypedArrayMap(
            val: ArrayMap<String!, T>?, 
            parcelableFlags: Int
        ): Unit

        Flatten an ArrayMap with string keys containing a particular object type into the parcel at the current dataPosition() and growing dataCapacity() if needed. The type of the objects in the array must be one that implements Parcelable. Only the raw data of the objects is written and not their type, so you must use the corresponding createTypedArrayMap(android.os.Parcelable.Creator)

        Parameters
        val ArrayMap<String!, T>?: The map of objects to be written. This value may be null.
        parcelableFlags Int: The parcelable flags to use.

        writeTypedList

        Added in API level 1
        fun <T : Parcelable!> writeTypedList(val: MutableList<T>?): Unit

        Flatten a List containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed. The type of the objects in the list must be one that implements Parcelable. Unlike the generic writeList() method, however, only the raw data of the objects is written and not their type, so you must use the corresponding readTypedList() to unmarshall them.

        Parameters
        val MutableList<T>?: The list of objects to be written. This value may be null.

        writeTypedList

        Added in API level 34
        fun <T : Parcelable!> writeTypedList(
            val: MutableList<T>?, 
            parcelableFlags: Int
        ): Unit

        Flatten a List containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed. The type of the objects in the list must be one that implements Parcelable. Unlike the generic writeList() method, however, only the raw data of the objects is written and not their type, so you must use the corresponding readTypedList() to unmarshall them.

        Parameters
        val MutableList<T>?: The list of objects to be written. This value may be null.
        parcelableFlags Int: Contextual flags as per Parcelable.writeToParcel().

        writeTypedObject

        Added in API level 23
        fun <T : Parcelable!> writeTypedObject(
            val: T?, 
            parcelableFlags: Int
        ): Unit

        Flatten the Parcelable object into the parcel.

        Parameters
        val T?: The Parcelable object to be written. This value may be null.
        parcelableFlags Int: Contextual flags as per Parcelable.writeToParcel().

        See Also

        writeTypedSparseArray

        Added in API level 29
        fun <T : Parcelable!> writeTypedSparseArray(
            val: SparseArray<T>?, 
            parcelableFlags: Int
        ): Unit

        Flatten a SparseArray containing a particular object type into the parcel at the current dataPosition() and growing dataCapacity() if needed. The type of the objects in the array must be one that implements Parcelable. Unlike the generic writeSparseArray(android.util.SparseArray) method, however, only the raw data of the objects is written and not their type, so you must use the corresponding createTypedSparseArray(android.os.Parcelable.Creator).

        Parameters
        val SparseArray<T>?: The list of objects to be written. This value may be null.
        parcelableFlags Int: The parcelable flags to use.

        writeValue

        Added in API level 1
        fun writeValue(v: Any?): Unit

        Flatten a generic object in to a parcel. The given Object value may currently be one of the following types:

        • null
        • String
        • Byte
        • Short
        • Integer
        • Long
        • Float
        • Double
        • Boolean
        • String[]
        • boolean[]
        • byte[]
        • int[]
        • long[]
        • Object[] (supporting objects of the same type defined here).
        • Bundle
        • Map (as supported by writeMap).
        • Any object that implements the Parcelable protocol.
        • Parcelable[]
        • CharSequence (as supported by TextUtils#writeToParcel).
        • List (as supported by writeList).
        • SparseArray (as supported by writeSparseArray(android.util.SparseArray)).
        • IBinder
        • Any object that implements Serializable (but see writeSerializable for caveats). Note that all of the previous types have relatively efficient implementations for writing to a Parcel; having to rely on the generic serialization approach is much less efficient and should be avoided whenever possible.

        Parcelable objects are written with Parcelable#writeToParcel using contextual flags of 0. When serializing objects containing ParcelFileDescriptors, this may result in file descriptor leaks when they are returned from Binder calls (where Parcelable#PARCELABLE_WRITE_RETURN_VALUE should be used).

        Parameters
        v Any?: This value may be null.

        Protected methods

        finalize

        Added in API level 1
        protected fun finalize(): Unit
        Exceptions
        java.lang.Throwable the Exception raised by this method

        Properties

        STRING_CREATOR

        Added in API level 1
        static val STRING_CREATOR: Parcelable.Creator<String!>!