public final class

Parcel

extends Object
java.lang.Object
   ↳ android.os.Parcel

Class Overview

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(byte), readByte(), writeDouble(double), readDouble(), writeFloat(float), readFloat(), writeInt(int), readInt(), writeLong(long), readLong(), writeString(String), 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(Parcelable, int) and readParcelable(ClassLoader) or writeParcelableArray(T[], int) and readParcelableArray(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: writeTypedArray(T[], int), writeTypedList(List), readTypedArray(T[], Parcelable.Creator) and readTypedList(List, Parcelable.Creator). 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 Parceable object, 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(Bundle), readBundle(), and readBundle(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(IBinder), writeStrongInterface(IInterface), readStrongBinder(), writeBinderArray(IBinder[]), readBinderArray(IBinder[]), createBinderArray(), writeBinderList(List), readBinderList(List), createBinderArrayList().

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(FileDescriptor), readFileDescriptor().

Untyped Containers

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

Summary

Fields
public static final Creator<String> STRING_CREATOR
Public Methods
final void appendFrom(Parcel parcel, int offset, int length)
final IBinder[] createBinderArray()
final ArrayList<IBinder> createBinderArrayList()
Read and return a new ArrayList containing IBinder objects from the parcel that was written with writeBinderList(List) at the current dataPosition().
final boolean[] createBooleanArray()
final byte[] createByteArray()
Read and return a byte[] object from the parcel.
final char[] createCharArray()
final double[] createDoubleArray()
final float[] createFloatArray()
final int[] createIntArray()
final long[] createLongArray()
final String[] createStringArray()
final ArrayList<String> createStringArrayList()
Read and return a new ArrayList containing String objects from the parcel that was written with writeStringList(List) at the current dataPosition().
final <T> T[] createTypedArray(Creator<T> c)
Read and return a new array containing a particular object type from the parcel at the current dataPosition().
final <T> ArrayList<T> createTypedArrayList(Creator<T> c)
Read and return a new ArrayList containing a particular object type from the parcel that was written with writeTypedList(List) at the current dataPosition().
final int dataAvail()
Returns the amount of data remaining to be read from the parcel.
final int dataCapacity()
Returns the total amount of space in the parcel.
final int dataPosition()
Returns the current position in the parcel data.
final int dataSize()
Returns the total amount of data contained in the parcel.
final void enforceInterface(String interfaceName)
final boolean hasFileDescriptors()
Report whether the parcel contains any marshalled file descriptors.
final byte[] marshall()
Returns the raw bytes of the parcel.
static Parcel obtain()
Retrieve a new Parcel object from the pool.
final Object[] readArray(ClassLoader loader)
Read and return a new Object array from the parcel at the current dataPosition().
final ArrayList readArrayList(ClassLoader loader)
Read and return a new ArrayList object from the parcel at the current dataPosition().
final void readBinderArray(IBinder[] val)
final void readBinderList(List<IBinder> list)
Read into the given List items IBinder objects that were written with writeBinderList(List) at the current dataPosition().
final void readBooleanArray(boolean[] val)
final Bundle readBundle(ClassLoader loader)
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.
final Bundle readBundle()
Read and return a new Bundle object from the parcel at the current dataPosition().
final byte readByte()
Read a byte value from the parcel at the current dataPosition().
final void readByteArray(byte[] val)
Read a byte[] object from the parcel and copy it into the given byte array.
final void readCharArray(char[] val)
final double readDouble()
Read a double precision floating point value from the parcel at the current dataPosition().
final void readDoubleArray(double[] val)
final void readException(int code, String msg)
Use this function for customized exception handling.
final void readException()
Special function for reading an exception result from the header of a parcel, to be used after receiving the result of a transaction.
final ParcelFileDescriptor readFileDescriptor()
Read a FileDescriptor from the parcel at the current dataPosition().
final float readFloat()
Read a floating point value from the parcel at the current dataPosition().
final void readFloatArray(float[] val)
final HashMap readHashMap(ClassLoader loader)
Please use readBundle(ClassLoader) instead (whose data must have been written with writeBundle(Bundle).
final int readInt()
Read an integer value from the parcel at the current dataPosition().
final void readIntArray(int[] val)
final void readList(List outVal, ClassLoader loader)
Read into an existing List object from the parcel at the current dataPosition(), using the given class loader to load any enclosed Parcelables.
final long readLong()
Read a long integer value from the parcel at the current dataPosition().
final void readLongArray(long[] val)
final void readMap(Map outVal, ClassLoader loader)
Please use readBundle(ClassLoader) instead (whose data must have been written with writeBundle(Bundle).
final <T extends Parcelable> T readParcelable(ClassLoader loader)
Read and return a new Parcelable from the parcel.
final Parcelable[] readParcelableArray(ClassLoader loader)
Read and return a new Parcelable array from the parcel.
final Serializable readSerializable()
Read and return a new Serializable object from the parcel.
final SparseArray readSparseArray(ClassLoader loader)
Read and return a new SparseArray object from the parcel at the current dataPosition().
final SparseBooleanArray readSparseBooleanArray()
Read and return a new SparseBooleanArray object from the parcel at the current dataPosition().
final String readString()
Read a string value from the parcel at the current dataPosition().
final void readStringArray(String[] val)
final void readStringList(List<String> list)
Read into the given List items String objects that were written with writeStringList(List) at the current dataPosition().
final IBinder readStrongBinder()
Read an object from the parcel at the current dataPosition().
final <T> void readTypedArray(T[] val, Creator<T> c)
final <T> void readTypedList(List<T> list, Creator<T> c)
Read into the given List items containing a particular object type that were written with writeTypedList(List) at the current dataPosition().
final Object readValue(ClassLoader loader)
Read a typed object from a parcel.
final void recycle()
Put a Parcel object back into the pool.
final void setDataCapacity(int size)
Change the capacity (current available space) of the parcel.
final void setDataPosition(int pos)
Move the current read/write position in the parcel.
final void setDataSize(int size)
Change the amount of data in the parcel.
final void unmarshall(byte[] data, int offest, int length)
Set the bytes in data to be the raw bytes of this Parcel.
final void writeArray(Object[] val)
Flatten an Object array into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeBinderArray(IBinder[] val)
final void writeBinderList(List<IBinder> val)
Flatten a List containing IBinder objects into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
final void writeBooleanArray(boolean[] val)
final void writeBundle(Bundle val)
Flatten a Bundle into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeByte(byte val)
Write an byte value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeByteArray(byte[] b, int offset, int len)
Write an byte array into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeByteArray(byte[] b)
Write a byte array into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeCharArray(char[] val)
final void writeDouble(double val)
Write a double precision floating point value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeDoubleArray(double[] val)
final void writeException(Exception e)
Special function for writing an exception result at the header of a parcel, to be used when returning an exception from a transaction.
final void writeFileDescriptor(FileDescriptor val)
Write a FileDescriptor into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeFloat(float val)
Write a floating point value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeFloatArray(float[] val)
final void writeInt(int val)
Write an integer value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeIntArray(int[] val)
final void writeInterfaceToken(String interfaceName)
Store or read an IBinder interface token in the parcel at the current dataPosition().
final void writeList(List val)
Flatten a List into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeLong(long val)
Write a long integer value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeLongArray(long[] val)
final void writeMap(Map val)
Please use writeBundle(Bundle) instead.
final void writeNoException()
Special function for writing information at the front of the Parcel indicating that no exception occurred.
final void writeParcelable(Parcelable p, int parcelableFlags)
Flatten the name of the class of the Parcelable and its contents into the parcel.
final <T extends Parcelable> void writeParcelableArray(T[] value, int parcelableFlags)
Write a heterogeneous array of Parcelable objects into the Parcel.
final void writeSerializable(Serializable s)
Write a generic serializable object in to a Parcel.
final void writeSparseArray(SparseArray<Object> val)
Flatten a generic SparseArray into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeSparseBooleanArray(SparseBooleanArray val)
final void writeString(String val)
Write a string value into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeStringArray(String[] val)
final void writeStringList(List<String> val)
Flatten a List containing String objects into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
final void writeStrongBinder(IBinder val)
Write an object into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final void writeStrongInterface(IInterface val)
Write an object into the parcel at the current dataPosition(), growing dataCapacity() if needed.
final <T extends Parcelable> void writeTypedArray(T[] val, int parcelableFlags)
Flatten a heterogeneous array containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
final <T extends Parcelable> void writeTypedList(List<T> val)
Flatten a List containing a particular object type into the parcel, at the current dataPosition() and growing dataCapacity() if needed.
final void writeValue(Object v)
Flatten a generic object in to a parcel.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
final static Parcel obtain(int obj)
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final Creator<String> STRING_CREATOR

Since: API Level 1

Public Methods

public final void appendFrom (Parcel parcel, int offset, int length)

Since: API Level 1

public final IBinder[] createBinderArray ()

Since: API Level 1

public final ArrayList<IBinder> createBinderArrayList ()

Since: API Level 1

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

Returns
  • A newly created ArrayList containing strings with the same data as those that were previously written.
See Also

public final boolean[] createBooleanArray ()

Since: API Level 1

public final byte[] createByteArray ()

Since: API Level 1

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

public final char[] createCharArray ()

Since: API Level 1

public final double[] createDoubleArray ()

Since: API Level 1

public final float[] createFloatArray ()

Since: API Level 1

public final int[] createIntArray ()

Since: API Level 1

public final long[] createLongArray ()

Since: API Level 1

public final String[] createStringArray ()

Since: API Level 1

public final ArrayList<String> createStringArrayList ()

Since: API Level 1

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

Returns
  • A newly created ArrayList containing strings with the same data as those that were previously written.
See Also

public final T[] createTypedArray (Creator<T> c)

Since: API Level 1

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(T[], int) with the same object type.

Returns
  • A newly created array containing objects with the same data as those that were previously written.
See Also

public final ArrayList<T> createTypedArrayList (Creator<T> c)

Since: API Level 1

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

Returns
  • A newly created ArrayList containing objects with the same data as those that were previously written.
See Also

public final int dataAvail ()

Since: API Level 1

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

public final int dataCapacity ()

Since: API Level 1

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.

public final int dataPosition ()

Since: API Level 1

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

public final int dataSize ()

Since: API Level 1

Returns the total amount of data contained in the parcel.

public final void enforceInterface (String interfaceName)

Since: API Level 1

public final boolean hasFileDescriptors ()

Since: API Level 1

Report whether the parcel contains any marshalled file descriptors.

public final byte[] marshall ()

Since: API Level 1

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.

public static Parcel obtain ()

Since: API Level 1

Retrieve a new Parcel object from the pool.

public final Object[] readArray (ClassLoader loader)

Since: API Level 1

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.

public final ArrayList readArrayList (ClassLoader loader)

Since: API Level 1

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.

public final void readBinderArray (IBinder[] val)

Since: API Level 1

public final void readBinderList (List<IBinder> list)

Since: API Level 1

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

Returns
  • A newly created ArrayList containing strings with the same data as those that were previously written.
See Also

public final void readBooleanArray (boolean[] val)

Since: API Level 1

public final Bundle readBundle (ClassLoader loader)

Since: API Level 1

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.

public final Bundle readBundle ()

Since: API Level 1

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

public final byte readByte ()

Since: API Level 1

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

public final void readByteArray (byte[] val)

Since: API Level 1

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

public final void readCharArray (char[] val)

Since: API Level 1

public final double readDouble ()

Since: API Level 1

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

public final void readDoubleArray (double[] val)

Since: API Level 1

public final void readException (int code, String msg)

Since: API Level 1

Use this function for customized exception handling. customized method call this method for all unknown case

Parameters
code exception code
msg exception message

public final void readException ()

Since: API Level 1

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.

See Also

public final ParcelFileDescriptor readFileDescriptor ()

Since: API Level 1

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

public final float readFloat ()

Since: API Level 1

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

public final void readFloatArray (float[] val)

Since: API Level 1

public final HashMap readHashMap (ClassLoader loader)

Since: API Level 1

Please use readBundle(ClassLoader) instead (whose data must have been written with writeBundle(Bundle). 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.

public final int readInt ()

Since: API Level 1

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

public final void readIntArray (int[] val)

Since: API Level 1

public final void readList (List outVal, ClassLoader loader)

Since: API Level 1

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.

public final long readLong ()

Since: API Level 1

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

public final void readLongArray (long[] val)

Since: API Level 1

public final void readMap (Map outVal, ClassLoader loader)

Since: API Level 1

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

public final T readParcelable (ClassLoader loader)

Since: API Level 1

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 A ClassLoader from which to instantiate the Parcelable object, or null for the default class loader.
Returns
  • Returns the newly created Parcelable, or null if a null object has been written.
Throws
BadParcelableException Throws BadParcelableException if there was an error trying to instantiate the Parcelable.

public final Parcelable[] readParcelableArray (ClassLoader loader)

Since: API Level 1

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

Returns
  • the Parcelable array, or null if the array is null

public final Serializable readSerializable ()

Since: API Level 1

Read and return a new Serializable object from the parcel.

Returns
  • the Serializable object, or null if the Serializable name wasn't found in the parcel.

public final SparseArray readSparseArray (ClassLoader loader)

Since: API Level 1

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.

public final SparseBooleanArray readSparseBooleanArray ()

Since: API Level 1

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

public final String readString ()

Since: API Level 1

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

public final void readStringArray (String[] val)

Since: API Level 1

public final void readStringList (List<String> list)

Since: API Level 1

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

Returns
  • A newly created ArrayList containing strings with the same data as those that were previously written.
See Also

public final IBinder readStrongBinder ()

Since: API Level 1

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

public final void readTypedArray (T[] val, Creator<T> c)

Since: API Level 1

public final void readTypedList (List<T> list, Creator<T> c)

Since: API Level 1

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

Returns
  • A newly created ArrayList containing objects with the same data as those that were previously written.
See Also

public final Object readValue (ClassLoader loader)

Since: API Level 1

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.

public final void recycle ()

Since: API Level 1

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

public final void setDataCapacity (int size)

Since: API Level 1

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

Parameters
size 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.

public final void setDataPosition (int pos)

Since: API Level 1

Move the current read/write position in the parcel.

Parameters
pos New offset in the parcel; must be between 0 and dataSize().

public final void setDataSize (int size)

Since: API Level 1

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 The new number of bytes in the Parcel.

public final void unmarshall (byte[] data, int offest, int length)

Since: API Level 1

Set the bytes in data to be the raw bytes of this Parcel.

public final void writeArray (Object[] val)

Since: API Level 1

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

public final void writeBinderArray (IBinder[] val)

Since: API Level 1

public final void writeBinderList (List<IBinder> val)

Since: API Level 1

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(List).

Parameters
val The list of strings to be written.
See Also

public final void writeBooleanArray (boolean[] val)

Since: API Level 1

public final void writeBundle (Bundle val)

Since: API Level 1

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

public final void writeByte (byte val)

Since: API Level 1

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

public final void writeByteArray (byte[] b, int offset, int len)

Since: API Level 1

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

Parameters
b Bytes to place into the parcel.
offset Index of first byte to be written.
len Number of bytes to write.

public final void writeByteArray (byte[] b)

Since: API Level 1

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

Parameters
b Bytes to place into the parcel.

public final void writeCharArray (char[] val)

Since: API Level 1

public final void writeDouble (double val)

Since: API Level 1

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

public final void writeDoubleArray (double[] val)

Since: API Level 1

public final void writeException (Exception e)

Since: API Level 1

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 The Exception to be written.
See Also

public final void writeFileDescriptor (FileDescriptor val)

Since: API Level 1

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 writeToParcel(Parcel, int) instead, which accepts contextual flags and will close the original file descriptor if PARCELABLE_WRITE_RETURN_VALUE is set.

public final void writeFloat (float val)

Since: API Level 1

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

public final void writeFloatArray (float[] val)

Since: API Level 1

public final void writeInt (int val)

Since: API Level 1

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

public final void writeIntArray (int[] val)

Since: API Level 1

public final void writeInterfaceToken (String interfaceName)

Since: API Level 1

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.

public final void writeList (List val)

Since: API Level 1

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

public final void writeLong (long val)

Since: API Level 1

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

public final void writeLongArray (long[] val)

Since: API Level 1

public final void writeMap (Map val)

Since: API Level 1

Please use writeBundle(Bundle) 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(Object) and must follow the specification there.

It is strongly recommended to use writeBundle(Bundle) 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.

public final void writeNoException ()

Since: API Level 1

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

See Also

public final void writeParcelable (Parcelable p, int parcelableFlags)

Since: API Level 1

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

Parameters
p The Parcelable object to be written.
parcelableFlags Contextual flags as per Parcelable.writeToParcel().

public final void writeParcelableArray (T[] value, int parcelableFlags)

Since: API Level 1

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(T[], int), but will correctly handle an array containing more than one type of object.

Parameters
value The array of objects to be written.
parcelableFlags Contextual flags as per Parcelable.writeToParcel().
See Also

public final void writeSerializable (Serializable s)

Since: API Level 1

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.

public final void writeSparseArray (SparseArray<Object> val)

Since: API Level 1

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

public final void writeSparseBooleanArray (SparseBooleanArray val)

Since: API Level 1

public final void writeString (String val)

Since: API Level 1

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

public final void writeStringArray (String[] val)

Since: API Level 1

public final void writeStringList (List<String> val)

Since: API Level 1

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(List).

Parameters
val The list of strings to be written.
See Also

public final void writeStrongBinder (IBinder val)

Since: API Level 1

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

public final void writeStrongInterface (IInterface val)

Since: API Level 1

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

public final void writeTypedArray (T[] val, int parcelableFlags)

Since: API Level 1

Flatten a heterogeneous 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(T[], int) method, however, only the raw data of the objects is written and not their type, so you must use readTypedArray(T[], Parcelable.Creator) with the correct corresponding Parcelable.Creator implementation to unmarshall them.

Parameters
val The array of objects to be written.
parcelableFlags Contextual flags as per Parcelable.writeToParcel().
See Also

public final void writeTypedList (List<T> val)

Since: API Level 1

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 The list of objects to be written.
See Also

public final void writeValue (Object v)

Since: API Level 1

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

Parcelable objects are written with writeToParcel(Parcel, int) 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_WRITE_RETURN_VALUE should be used).

Protected Methods

protected void finalize ()

Since: API Level 1

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable

protected static final Parcel obtain (int obj)

Since: API Level 1