blob: 5f3a81c9c7a63e912a5a3bf2c52e11876009b63f [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.os;
18
19import android.text.TextUtils;
Dianne Hackbornb87655b2013-07-17 19:06:22 -070020import android.util.ArrayMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080021import android.util.Log;
22import android.util.SparseArray;
23import android.util.SparseBooleanArray;
24
25import java.io.ByteArrayInputStream;
26import java.io.ByteArrayOutputStream;
27import java.io.FileDescriptor;
28import java.io.FileNotFoundException;
29import java.io.IOException;
30import java.io.ObjectInputStream;
31import java.io.ObjectOutputStream;
32import java.io.Serializable;
33import java.lang.reflect.Field;
34import java.util.ArrayList;
Elliott Hughesa28b83e2011-02-28 14:26:13 -080035import java.util.Arrays;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080036import java.util.HashMap;
37import java.util.List;
38import java.util.Map;
39import java.util.Set;
40
41/**
42 * Container for a message (data and object references) that can
43 * be sent through an IBinder. A Parcel can contain both flattened data
44 * that will be unflattened on the other side of the IPC (using the various
45 * methods here for writing specific types, or the general
46 * {@link Parcelable} interface), and references to live {@link IBinder}
47 * objects that will result in the other side receiving a proxy IBinder
48 * connected with the original IBinder in the Parcel.
49 *
50 * <p class="note">Parcel is <strong>not</strong> a general-purpose
51 * serialization mechanism. This class (and the corresponding
52 * {@link Parcelable} API for placing arbitrary objects into a Parcel) is
53 * designed as a high-performance IPC transport. As such, it is not
54 * appropriate to place any Parcel data in to persistent storage: changes
55 * in the underlying implementation of any of the data in the Parcel can
56 * render older data unreadable.</p>
57 *
58 * <p>The bulk of the Parcel API revolves around reading and writing data
59 * of various types. There are six major classes of such functions available.</p>
60 *
61 * <h3>Primitives</h3>
62 *
63 * <p>The most basic data functions are for writing and reading primitive
64 * data types: {@link #writeByte}, {@link #readByte}, {@link #writeDouble},
65 * {@link #readDouble}, {@link #writeFloat}, {@link #readFloat}, {@link #writeInt},
66 * {@link #readInt}, {@link #writeLong}, {@link #readLong},
67 * {@link #writeString}, {@link #readString}. Most other
68 * data operations are built on top of these. The given data is written and
69 * read using the endianess of the host CPU.</p>
70 *
71 * <h3>Primitive Arrays</h3>
72 *
73 * <p>There are a variety of methods for reading and writing raw arrays
74 * of primitive objects, which generally result in writing a 4-byte length
75 * followed by the primitive data items. The methods for reading can either
76 * read the data into an existing array, or create and return a new array.
77 * These available types are:</p>
78 *
79 * <ul>
80 * <li> {@link #writeBooleanArray(boolean[])},
81 * {@link #readBooleanArray(boolean[])}, {@link #createBooleanArray()}
82 * <li> {@link #writeByteArray(byte[])},
83 * {@link #writeByteArray(byte[], int, int)}, {@link #readByteArray(byte[])},
84 * {@link #createByteArray()}
85 * <li> {@link #writeCharArray(char[])}, {@link #readCharArray(char[])},
86 * {@link #createCharArray()}
87 * <li> {@link #writeDoubleArray(double[])}, {@link #readDoubleArray(double[])},
88 * {@link #createDoubleArray()}
89 * <li> {@link #writeFloatArray(float[])}, {@link #readFloatArray(float[])},
90 * {@link #createFloatArray()}
91 * <li> {@link #writeIntArray(int[])}, {@link #readIntArray(int[])},
92 * {@link #createIntArray()}
93 * <li> {@link #writeLongArray(long[])}, {@link #readLongArray(long[])},
94 * {@link #createLongArray()}
95 * <li> {@link #writeStringArray(String[])}, {@link #readStringArray(String[])},
96 * {@link #createStringArray()}.
97 * <li> {@link #writeSparseBooleanArray(SparseBooleanArray)},
98 * {@link #readSparseBooleanArray()}.
99 * </ul>
100 *
101 * <h3>Parcelables</h3>
102 *
103 * <p>The {@link Parcelable} protocol provides an extremely efficient (but
104 * low-level) protocol for objects to write and read themselves from Parcels.
105 * You can use the direct methods {@link #writeParcelable(Parcelable, int)}
106 * and {@link #readParcelable(ClassLoader)} or
107 * {@link #writeParcelableArray} and
108 * {@link #readParcelableArray(ClassLoader)} to write or read. These
109 * methods write both the class type and its data to the Parcel, allowing
110 * that class to be reconstructed from the appropriate class loader when
111 * later reading.</p>
112 *
113 * <p>There are also some methods that provide a more efficient way to work
114 * with Parcelables: {@link #writeTypedArray},
115 * {@link #writeTypedList(List)},
116 * {@link #readTypedArray} and {@link #readTypedList}. These methods
117 * do not write the class information of the original object: instead, the
118 * caller of the read function must know what type to expect and pass in the
119 * appropriate {@link Parcelable.Creator Parcelable.Creator} instead to
120 * properly construct the new object and read its data. (To more efficient
121 * write and read a single Parceable object, you can directly call
122 * {@link Parcelable#writeToParcel Parcelable.writeToParcel} and
123 * {@link Parcelable.Creator#createFromParcel Parcelable.Creator.createFromParcel}
124 * yourself.)</p>
125 *
126 * <h3>Bundles</h3>
127 *
128 * <p>A special type-safe container, called {@link Bundle}, is available
129 * for key/value maps of heterogeneous values. This has many optimizations
130 * for improved performance when reading and writing data, and its type-safe
131 * API avoids difficult to debug type errors when finally marshalling the
132 * data contents into a Parcel. The methods to use are
133 * {@link #writeBundle(Bundle)}, {@link #readBundle()}, and
134 * {@link #readBundle(ClassLoader)}.
135 *
136 * <h3>Active Objects</h3>
137 *
138 * <p>An unusual feature of Parcel is the ability to read and write active
139 * objects. For these objects the actual contents of the object is not
140 * written, rather a special token referencing the object is written. When
141 * reading the object back from the Parcel, you do not get a new instance of
142 * the object, but rather a handle that operates on the exact same object that
143 * was originally written. There are two forms of active objects available.</p>
144 *
145 * <p>{@link Binder} objects are a core facility of Android's general cross-process
146 * communication system. The {@link IBinder} interface describes an abstract
147 * protocol with a Binder object. Any such interface can be written in to
148 * a Parcel, and upon reading you will receive either the original object
149 * implementing that interface or a special proxy implementation
150 * that communicates calls back to the original object. The methods to use are
151 * {@link #writeStrongBinder(IBinder)},
152 * {@link #writeStrongInterface(IInterface)}, {@link #readStrongBinder()},
153 * {@link #writeBinderArray(IBinder[])}, {@link #readBinderArray(IBinder[])},
154 * {@link #createBinderArray()},
155 * {@link #writeBinderList(List)}, {@link #readBinderList(List)},
156 * {@link #createBinderArrayList()}.</p>
157 *
158 * <p>FileDescriptor objects, representing raw Linux file descriptor identifiers,
159 * can be written and {@link ParcelFileDescriptor} objects returned to operate
160 * on the original file descriptor. The returned file descriptor is a dup
161 * of the original file descriptor: the object and fd is different, but
162 * operating on the same underlying file stream, with the same position, etc.
163 * The methods to use are {@link #writeFileDescriptor(FileDescriptor)},
164 * {@link #readFileDescriptor()}.
165 *
166 * <h3>Untyped Containers</h3>
167 *
168 * <p>A final class of methods are for writing and reading standard Java
169 * containers of arbitrary types. These all revolve around the
170 * {@link #writeValue(Object)} and {@link #readValue(ClassLoader)} methods
171 * which define the types of objects allowed. The container methods are
172 * {@link #writeArray(Object[])}, {@link #readArray(ClassLoader)},
173 * {@link #writeList(List)}, {@link #readList(List, ClassLoader)},
174 * {@link #readArrayList(ClassLoader)},
175 * {@link #writeMap(Map)}, {@link #readMap(Map, ClassLoader)},
176 * {@link #writeSparseArray(SparseArray)},
177 * {@link #readSparseArray(ClassLoader)}.
178 */
179public final class Parcel {
180 private static final boolean DEBUG_RECYCLE = false;
Dianne Hackborne784d1e2013-09-20 18:13:52 -0700181 private static final boolean DEBUG_ARRAY_MAP = false;
Brad Fitzpatrick5b747192010-07-12 11:05:38 -0700182 private static final String TAG = "Parcel";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800183
184 @SuppressWarnings({"UnusedDeclaration"})
Jeff Sharkey047238c2012-03-07 16:51:38 -0800185 private int mNativePtr; // used by native code
186
187 /**
188 * Flag indicating if {@link #mNativePtr} was allocated by this object,
189 * indicating that we're responsible for its lifecycle.
190 */
191 private boolean mOwnsNativeParcelObject;
192
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800193 private RuntimeException mStack;
194
195 private static final int POOL_SIZE = 6;
196 private static final Parcel[] sOwnedPool = new Parcel[POOL_SIZE];
197 private static final Parcel[] sHolderPool = new Parcel[POOL_SIZE];
198
199 private static final int VAL_NULL = -1;
200 private static final int VAL_STRING = 0;
201 private static final int VAL_INTEGER = 1;
202 private static final int VAL_MAP = 2;
203 private static final int VAL_BUNDLE = 3;
204 private static final int VAL_PARCELABLE = 4;
205 private static final int VAL_SHORT = 5;
206 private static final int VAL_LONG = 6;
207 private static final int VAL_FLOAT = 7;
208 private static final int VAL_DOUBLE = 8;
209 private static final int VAL_BOOLEAN = 9;
210 private static final int VAL_CHARSEQUENCE = 10;
211 private static final int VAL_LIST = 11;
212 private static final int VAL_SPARSEARRAY = 12;
213 private static final int VAL_BYTEARRAY = 13;
214 private static final int VAL_STRINGARRAY = 14;
215 private static final int VAL_IBINDER = 15;
216 private static final int VAL_PARCELABLEARRAY = 16;
217 private static final int VAL_OBJECTARRAY = 17;
218 private static final int VAL_INTARRAY = 18;
219 private static final int VAL_LONGARRAY = 19;
220 private static final int VAL_BYTE = 20;
221 private static final int VAL_SERIALIZABLE = 21;
222 private static final int VAL_SPARSEBOOLEANARRAY = 22;
223 private static final int VAL_BOOLEANARRAY = 23;
Bjorn Bringert08bbffb2010-02-25 11:16:22 +0000224 private static final int VAL_CHARSEQUENCEARRAY = 24;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800225
Brad Fitzpatrick5b747192010-07-12 11:05:38 -0700226 // The initial int32 in a Binder call's reply Parcel header:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800227 private static final int EX_SECURITY = -1;
228 private static final int EX_BAD_PARCELABLE = -2;
229 private static final int EX_ILLEGAL_ARGUMENT = -3;
230 private static final int EX_NULL_POINTER = -4;
231 private static final int EX_ILLEGAL_STATE = -5;
Dianne Hackborn7e714422013-09-13 17:32:57 -0700232 private static final int EX_NETWORK_MAIN_THREAD = -6;
Brad Fitzpatrick5b747192010-07-12 11:05:38 -0700233 private static final int EX_HAS_REPLY_HEADER = -128; // special; see below
234
Jeff Sharkey047238c2012-03-07 16:51:38 -0800235 private static native int nativeDataSize(int nativePtr);
236 private static native int nativeDataAvail(int nativePtr);
237 private static native int nativeDataPosition(int nativePtr);
238 private static native int nativeDataCapacity(int nativePtr);
239 private static native void nativeSetDataSize(int nativePtr, int size);
240 private static native void nativeSetDataPosition(int nativePtr, int pos);
241 private static native void nativeSetDataCapacity(int nativePtr, int size);
242
243 private static native boolean nativePushAllowFds(int nativePtr, boolean allowFds);
244 private static native void nativeRestoreAllowFds(int nativePtr, boolean lastValue);
245
246 private static native void nativeWriteByteArray(int nativePtr, byte[] b, int offset, int len);
247 private static native void nativeWriteInt(int nativePtr, int val);
248 private static native void nativeWriteLong(int nativePtr, long val);
249 private static native void nativeWriteFloat(int nativePtr, float val);
250 private static native void nativeWriteDouble(int nativePtr, double val);
251 private static native void nativeWriteString(int nativePtr, String val);
252 private static native void nativeWriteStrongBinder(int nativePtr, IBinder val);
253 private static native void nativeWriteFileDescriptor(int nativePtr, FileDescriptor val);
254
255 private static native byte[] nativeCreateByteArray(int nativePtr);
256 private static native int nativeReadInt(int nativePtr);
257 private static native long nativeReadLong(int nativePtr);
258 private static native float nativeReadFloat(int nativePtr);
259 private static native double nativeReadDouble(int nativePtr);
260 private static native String nativeReadString(int nativePtr);
261 private static native IBinder nativeReadStrongBinder(int nativePtr);
262 private static native FileDescriptor nativeReadFileDescriptor(int nativePtr);
263
264 private static native int nativeCreate();
265 private static native void nativeFreeBuffer(int nativePtr);
266 private static native void nativeDestroy(int nativePtr);
267
268 private static native byte[] nativeMarshall(int nativePtr);
269 private static native void nativeUnmarshall(
270 int nativePtr, byte[] data, int offest, int length);
271 private static native void nativeAppendFrom(
272 int thisNativePtr, int otherNativePtr, int offset, int length);
273 private static native boolean nativeHasFileDescriptors(int nativePtr);
274 private static native void nativeWriteInterfaceToken(int nativePtr, String interfaceName);
275 private static native void nativeEnforceInterface(int nativePtr, String interfaceName);
276
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800277 public final static Parcelable.Creator<String> STRING_CREATOR
278 = new Parcelable.Creator<String>() {
279 public String createFromParcel(Parcel source) {
280 return source.readString();
281 }
282 public String[] newArray(int size) {
283 return new String[size];
284 }
285 };
286
287 /**
288 * Retrieve a new Parcel object from the pool.
289 */
290 public static Parcel obtain() {
291 final Parcel[] pool = sOwnedPool;
292 synchronized (pool) {
293 Parcel p;
294 for (int i=0; i<POOL_SIZE; i++) {
295 p = pool[i];
296 if (p != null) {
297 pool[i] = null;
298 if (DEBUG_RECYCLE) {
299 p.mStack = new RuntimeException();
300 }
301 return p;
302 }
303 }
304 }
305 return new Parcel(0);
306 }
307
308 /**
309 * Put a Parcel object back into the pool. You must not touch
310 * the object after this call.
311 */
312 public final void recycle() {
313 if (DEBUG_RECYCLE) mStack = null;
314 freeBuffer();
Jeff Sharkey047238c2012-03-07 16:51:38 -0800315
316 final Parcel[] pool;
317 if (mOwnsNativeParcelObject) {
318 pool = sOwnedPool;
319 } else {
320 mNativePtr = 0;
321 pool = sHolderPool;
322 }
323
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800324 synchronized (pool) {
325 for (int i=0; i<POOL_SIZE; i++) {
326 if (pool[i] == null) {
327 pool[i] = this;
328 return;
329 }
330 }
331 }
332 }
333
334 /**
335 * Returns the total amount of data contained in the parcel.
336 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800337 public final int dataSize() {
338 return nativeDataSize(mNativePtr);
339 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800340
341 /**
342 * Returns the amount of data remaining to be read from the
343 * parcel. That is, {@link #dataSize}-{@link #dataPosition}.
344 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800345 public final int dataAvail() {
346 return nativeDataAvail(mNativePtr);
347 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800348
349 /**
350 * Returns the current position in the parcel data. Never
351 * more than {@link #dataSize}.
352 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800353 public final int dataPosition() {
354 return nativeDataPosition(mNativePtr);
355 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800356
357 /**
358 * Returns the total amount of space in the parcel. This is always
359 * >= {@link #dataSize}. The difference between it and dataSize() is the
360 * amount of room left until the parcel needs to re-allocate its
361 * data buffer.
362 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800363 public final int dataCapacity() {
364 return nativeDataCapacity(mNativePtr);
365 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800366
367 /**
368 * Change the amount of data in the parcel. Can be either smaller or
369 * larger than the current size. If larger than the current capacity,
370 * more memory will be allocated.
371 *
372 * @param size The new number of bytes in the Parcel.
373 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800374 public final void setDataSize(int size) {
375 nativeSetDataSize(mNativePtr, size);
376 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800377
378 /**
379 * Move the current read/write position in the parcel.
380 * @param pos New offset in the parcel; must be between 0 and
381 * {@link #dataSize}.
382 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800383 public final void setDataPosition(int pos) {
384 nativeSetDataPosition(mNativePtr, pos);
385 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800386
387 /**
388 * Change the capacity (current available space) of the parcel.
389 *
390 * @param size The new capacity of the parcel, in bytes. Can not be
391 * less than {@link #dataSize} -- that is, you can not drop existing data
392 * with this method.
393 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800394 public final void setDataCapacity(int size) {
395 nativeSetDataCapacity(mNativePtr, size);
396 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800397
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -0400398 /** @hide */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800399 public final boolean pushAllowFds(boolean allowFds) {
400 return nativePushAllowFds(mNativePtr, allowFds);
401 }
Dianne Hackbornc04db7e2011-10-03 21:09:35 -0700402
403 /** @hide */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800404 public final void restoreAllowFds(boolean lastValue) {
405 nativeRestoreAllowFds(mNativePtr, lastValue);
406 }
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -0400407
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800408 /**
409 * Returns the raw bytes of the parcel.
410 *
411 * <p class="note">The data you retrieve here <strong>must not</strong>
412 * be placed in any kind of persistent storage (on local disk, across
413 * a network, etc). For that, you should use standard serialization
414 * or another kind of general serialization mechanism. The Parcel
415 * marshalled representation is highly optimized for local IPC, and as
416 * such does not attempt to maintain compatibility with data created
417 * in different versions of the platform.
418 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800419 public final byte[] marshall() {
420 return nativeMarshall(mNativePtr);
421 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800422
423 /**
424 * Set the bytes in data to be the raw bytes of this Parcel.
425 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800426 public final void unmarshall(byte[] data, int offest, int length) {
427 nativeUnmarshall(mNativePtr, data, offest, length);
428 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800429
Jeff Sharkey047238c2012-03-07 16:51:38 -0800430 public final void appendFrom(Parcel parcel, int offset, int length) {
431 nativeAppendFrom(mNativePtr, parcel.mNativePtr, offset, length);
432 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800433
434 /**
435 * Report whether the parcel contains any marshalled file descriptors.
436 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800437 public final boolean hasFileDescriptors() {
438 return nativeHasFileDescriptors(mNativePtr);
439 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800440
441 /**
442 * Store or read an IBinder interface token in the parcel at the current
443 * {@link #dataPosition}. This is used to validate that the marshalled
444 * transaction is intended for the target interface.
445 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800446 public final void writeInterfaceToken(String interfaceName) {
447 nativeWriteInterfaceToken(mNativePtr, interfaceName);
448 }
449
450 public final void enforceInterface(String interfaceName) {
451 nativeEnforceInterface(mNativePtr, interfaceName);
452 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800453
454 /**
Elliott Hughesa28b83e2011-02-28 14:26:13 -0800455 * Write a byte array into the parcel at the current {@link #dataPosition},
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800456 * growing {@link #dataCapacity} if needed.
457 * @param b Bytes to place into the parcel.
458 */
459 public final void writeByteArray(byte[] b) {
460 writeByteArray(b, 0, (b != null) ? b.length : 0);
461 }
462
463 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900464 * Write a byte array into the parcel at the current {@link #dataPosition},
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800465 * growing {@link #dataCapacity} if needed.
466 * @param b Bytes to place into the parcel.
467 * @param offset Index of first byte to be written.
468 * @param len Number of bytes to write.
469 */
470 public final void writeByteArray(byte[] b, int offset, int len) {
471 if (b == null) {
472 writeInt(-1);
473 return;
474 }
Elliott Hughesa28b83e2011-02-28 14:26:13 -0800475 Arrays.checkOffsetAndCount(b.length, offset, len);
Jeff Sharkey047238c2012-03-07 16:51:38 -0800476 nativeWriteByteArray(mNativePtr, b, offset, len);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800477 }
478
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800479 /**
480 * Write an integer value into the parcel at the current dataPosition(),
481 * growing dataCapacity() if needed.
482 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800483 public final void writeInt(int val) {
484 nativeWriteInt(mNativePtr, val);
485 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800486
487 /**
488 * Write a long integer value into the parcel at the current dataPosition(),
489 * growing dataCapacity() if needed.
490 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800491 public final void writeLong(long val) {
492 nativeWriteLong(mNativePtr, val);
493 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800494
495 /**
496 * Write a floating point value into the parcel at the current
497 * dataPosition(), growing dataCapacity() if needed.
498 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800499 public final void writeFloat(float val) {
500 nativeWriteFloat(mNativePtr, val);
501 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800502
503 /**
504 * Write a double precision floating point value into the parcel at the
505 * current dataPosition(), growing dataCapacity() if needed.
506 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800507 public final void writeDouble(double val) {
508 nativeWriteDouble(mNativePtr, val);
509 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800510
511 /**
512 * Write a string value into the parcel at the current dataPosition(),
513 * growing dataCapacity() if needed.
514 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800515 public final void writeString(String val) {
516 nativeWriteString(mNativePtr, val);
517 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518
519 /**
Bjorn Bringert08bbffb2010-02-25 11:16:22 +0000520 * Write a CharSequence value into the parcel at the current dataPosition(),
521 * growing dataCapacity() if needed.
522 * @hide
523 */
524 public final void writeCharSequence(CharSequence val) {
525 TextUtils.writeToParcel(val, this, 0);
526 }
527
528 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800529 * Write an object into the parcel at the current dataPosition(),
530 * growing dataCapacity() if needed.
531 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800532 public final void writeStrongBinder(IBinder val) {
533 nativeWriteStrongBinder(mNativePtr, val);
534 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800535
536 /**
537 * Write an object into the parcel at the current dataPosition(),
538 * growing dataCapacity() if needed.
539 */
540 public final void writeStrongInterface(IInterface val) {
541 writeStrongBinder(val == null ? null : val.asBinder());
542 }
543
544 /**
545 * Write a FileDescriptor into the parcel at the current dataPosition(),
546 * growing dataCapacity() if needed.
Dan Egnorb3e4ef32010-07-20 09:03:35 -0700547 *
548 * <p class="caution">The file descriptor will not be closed, which may
549 * result in file descriptor leaks when objects are returned from Binder
550 * calls. Use {@link ParcelFileDescriptor#writeToParcel} instead, which
551 * accepts contextual flags and will close the original file descriptor
552 * if {@link Parcelable#PARCELABLE_WRITE_RETURN_VALUE} is set.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800553 */
Jeff Sharkey047238c2012-03-07 16:51:38 -0800554 public final void writeFileDescriptor(FileDescriptor val) {
555 nativeWriteFileDescriptor(mNativePtr, val);
556 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800557
558 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900559 * Write a byte value into the parcel at the current dataPosition(),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800560 * growing dataCapacity() if needed.
561 */
562 public final void writeByte(byte val) {
563 writeInt(val);
564 }
565
566 /**
567 * Please use {@link #writeBundle} instead. Flattens a Map into the parcel
568 * at the current dataPosition(),
569 * growing dataCapacity() if needed. The Map keys must be String objects.
570 * The Map values are written using {@link #writeValue} and must follow
571 * the specification there.
572 *
573 * <p>It is strongly recommended to use {@link #writeBundle} instead of
574 * this method, since the Bundle class provides a type-safe API that
575 * allows you to avoid mysterious type errors at the point of marshalling.
576 */
577 public final void writeMap(Map val) {
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700578 writeMapInternal((Map<String, Object>) val);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800579 }
580
581 /**
582 * Flatten a Map into the parcel at the current dataPosition(),
583 * growing dataCapacity() if needed. The Map keys must be String objects.
584 */
Dianne Hackborn6aff9052009-05-22 13:20:23 -0700585 /* package */ void writeMapInternal(Map<String,Object> val) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800586 if (val == null) {
587 writeInt(-1);
588 return;
589 }
590 Set<Map.Entry<String,Object>> entries = val.entrySet();
591 writeInt(entries.size());
592 for (Map.Entry<String,Object> e : entries) {
593 writeValue(e.getKey());
594 writeValue(e.getValue());
595 }
596 }
597
598 /**
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700599 * Flatten an ArrayMap into the parcel at the current dataPosition(),
600 * growing dataCapacity() if needed. The Map keys must be String objects.
601 */
602 /* package */ void writeArrayMapInternal(ArrayMap<String,Object> val) {
603 if (val == null) {
604 writeInt(-1);
605 return;
606 }
607 final int N = val.size();
608 writeInt(N);
Dianne Hackborne784d1e2013-09-20 18:13:52 -0700609 if (DEBUG_ARRAY_MAP) {
610 RuntimeException here = new RuntimeException("here");
611 here.fillInStackTrace();
612 Log.d(TAG, "Writing " + N + " ArrayMap entries", here);
613 }
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700614 for (int i=0; i<N; i++) {
Dianne Hackborne784d1e2013-09-20 18:13:52 -0700615 if (DEBUG_ARRAY_MAP) Log.d(TAG, " Write #" + i + ": key=0x"
616 + (val.keyAt(i) != null ? val.keyAt(i).hashCode() : 0) + " " + val.keyAt(i));
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700617 writeValue(val.keyAt(i));
618 writeValue(val.valueAt(i));
619 }
620 }
621
622 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800623 * Flatten a Bundle into the parcel at the current dataPosition(),
624 * growing dataCapacity() if needed.
625 */
626 public final void writeBundle(Bundle val) {
627 if (val == null) {
628 writeInt(-1);
629 return;
630 }
631
Dianne Hackborn6aff9052009-05-22 13:20:23 -0700632 val.writeToParcel(this, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800633 }
634
635 /**
636 * Flatten a List into the parcel at the current dataPosition(), growing
637 * dataCapacity() if needed. The List values are written using
638 * {@link #writeValue} and must follow the specification there.
639 */
640 public final void writeList(List val) {
641 if (val == null) {
642 writeInt(-1);
643 return;
644 }
645 int N = val.size();
646 int i=0;
647 writeInt(N);
648 while (i < N) {
649 writeValue(val.get(i));
650 i++;
651 }
652 }
653
654 /**
655 * Flatten an Object array into the parcel at the current dataPosition(),
656 * growing dataCapacity() if needed. The array values are written using
657 * {@link #writeValue} and must follow the specification there.
658 */
659 public final void writeArray(Object[] val) {
660 if (val == null) {
661 writeInt(-1);
662 return;
663 }
664 int N = val.length;
665 int i=0;
666 writeInt(N);
667 while (i < N) {
668 writeValue(val[i]);
669 i++;
670 }
671 }
672
673 /**
674 * Flatten a generic SparseArray into the parcel at the current
675 * dataPosition(), growing dataCapacity() if needed. The SparseArray
676 * values are written using {@link #writeValue} and must follow the
677 * specification there.
678 */
679 public final void writeSparseArray(SparseArray<Object> val) {
680 if (val == null) {
681 writeInt(-1);
682 return;
683 }
684 int N = val.size();
685 writeInt(N);
686 int i=0;
687 while (i < N) {
688 writeInt(val.keyAt(i));
689 writeValue(val.valueAt(i));
690 i++;
691 }
692 }
693
694 public final void writeSparseBooleanArray(SparseBooleanArray val) {
695 if (val == null) {
696 writeInt(-1);
697 return;
698 }
699 int N = val.size();
700 writeInt(N);
701 int i=0;
702 while (i < N) {
703 writeInt(val.keyAt(i));
704 writeByte((byte)(val.valueAt(i) ? 1 : 0));
705 i++;
706 }
707 }
708
709 public final void writeBooleanArray(boolean[] val) {
710 if (val != null) {
711 int N = val.length;
712 writeInt(N);
713 for (int i=0; i<N; i++) {
714 writeInt(val[i] ? 1 : 0);
715 }
716 } else {
717 writeInt(-1);
718 }
719 }
720
721 public final boolean[] createBooleanArray() {
722 int N = readInt();
723 // >>2 as a fast divide-by-4 works in the create*Array() functions
724 // because dataAvail() will never return a negative number. 4 is
725 // the size of a stored boolean in the stream.
726 if (N >= 0 && N <= (dataAvail() >> 2)) {
727 boolean[] val = new boolean[N];
728 for (int i=0; i<N; i++) {
729 val[i] = readInt() != 0;
730 }
731 return val;
732 } else {
733 return null;
734 }
735 }
736
737 public final void readBooleanArray(boolean[] val) {
738 int N = readInt();
739 if (N == val.length) {
740 for (int i=0; i<N; i++) {
741 val[i] = readInt() != 0;
742 }
743 } else {
744 throw new RuntimeException("bad array lengths");
745 }
746 }
747
748 public final void writeCharArray(char[] val) {
749 if (val != null) {
750 int N = val.length;
751 writeInt(N);
752 for (int i=0; i<N; i++) {
753 writeInt((int)val[i]);
754 }
755 } else {
756 writeInt(-1);
757 }
758 }
759
760 public final char[] createCharArray() {
761 int N = readInt();
762 if (N >= 0 && N <= (dataAvail() >> 2)) {
763 char[] val = new char[N];
764 for (int i=0; i<N; i++) {
765 val[i] = (char)readInt();
766 }
767 return val;
768 } else {
769 return null;
770 }
771 }
772
773 public final void readCharArray(char[] val) {
774 int N = readInt();
775 if (N == val.length) {
776 for (int i=0; i<N; i++) {
777 val[i] = (char)readInt();
778 }
779 } else {
780 throw new RuntimeException("bad array lengths");
781 }
782 }
783
784 public final void writeIntArray(int[] val) {
785 if (val != null) {
786 int N = val.length;
787 writeInt(N);
788 for (int i=0; i<N; i++) {
789 writeInt(val[i]);
790 }
791 } else {
792 writeInt(-1);
793 }
794 }
795
796 public final int[] createIntArray() {
797 int N = readInt();
798 if (N >= 0 && N <= (dataAvail() >> 2)) {
799 int[] val = new int[N];
800 for (int i=0; i<N; i++) {
801 val[i] = readInt();
802 }
803 return val;
804 } else {
805 return null;
806 }
807 }
808
809 public final void readIntArray(int[] val) {
810 int N = readInt();
811 if (N == val.length) {
812 for (int i=0; i<N; i++) {
813 val[i] = readInt();
814 }
815 } else {
816 throw new RuntimeException("bad array lengths");
817 }
818 }
819
820 public final void writeLongArray(long[] val) {
821 if (val != null) {
822 int N = val.length;
823 writeInt(N);
824 for (int i=0; i<N; i++) {
825 writeLong(val[i]);
826 }
827 } else {
828 writeInt(-1);
829 }
830 }
831
832 public final long[] createLongArray() {
833 int N = readInt();
834 // >>3 because stored longs are 64 bits
835 if (N >= 0 && N <= (dataAvail() >> 3)) {
836 long[] val = new long[N];
837 for (int i=0; i<N; i++) {
838 val[i] = readLong();
839 }
840 return val;
841 } else {
842 return null;
843 }
844 }
845
846 public final void readLongArray(long[] val) {
847 int N = readInt();
848 if (N == val.length) {
849 for (int i=0; i<N; i++) {
850 val[i] = readLong();
851 }
852 } else {
853 throw new RuntimeException("bad array lengths");
854 }
855 }
856
857 public final void writeFloatArray(float[] val) {
858 if (val != null) {
859 int N = val.length;
860 writeInt(N);
861 for (int i=0; i<N; i++) {
862 writeFloat(val[i]);
863 }
864 } else {
865 writeInt(-1);
866 }
867 }
868
869 public final float[] createFloatArray() {
870 int N = readInt();
871 // >>2 because stored floats are 4 bytes
872 if (N >= 0 && N <= (dataAvail() >> 2)) {
873 float[] val = new float[N];
874 for (int i=0; i<N; i++) {
875 val[i] = readFloat();
876 }
877 return val;
878 } else {
879 return null;
880 }
881 }
882
883 public final void readFloatArray(float[] val) {
884 int N = readInt();
885 if (N == val.length) {
886 for (int i=0; i<N; i++) {
887 val[i] = readFloat();
888 }
889 } else {
890 throw new RuntimeException("bad array lengths");
891 }
892 }
893
894 public final void writeDoubleArray(double[] val) {
895 if (val != null) {
896 int N = val.length;
897 writeInt(N);
898 for (int i=0; i<N; i++) {
899 writeDouble(val[i]);
900 }
901 } else {
902 writeInt(-1);
903 }
904 }
905
906 public final double[] createDoubleArray() {
907 int N = readInt();
908 // >>3 because stored doubles are 8 bytes
909 if (N >= 0 && N <= (dataAvail() >> 3)) {
910 double[] val = new double[N];
911 for (int i=0; i<N; i++) {
912 val[i] = readDouble();
913 }
914 return val;
915 } else {
916 return null;
917 }
918 }
919
920 public final void readDoubleArray(double[] val) {
921 int N = readInt();
922 if (N == val.length) {
923 for (int i=0; i<N; i++) {
924 val[i] = readDouble();
925 }
926 } else {
927 throw new RuntimeException("bad array lengths");
928 }
929 }
930
931 public final void writeStringArray(String[] val) {
932 if (val != null) {
933 int N = val.length;
934 writeInt(N);
935 for (int i=0; i<N; i++) {
936 writeString(val[i]);
937 }
938 } else {
939 writeInt(-1);
940 }
941 }
942
943 public final String[] createStringArray() {
944 int N = readInt();
945 if (N >= 0) {
946 String[] val = new String[N];
947 for (int i=0; i<N; i++) {
948 val[i] = readString();
949 }
950 return val;
951 } else {
952 return null;
953 }
954 }
955
956 public final void readStringArray(String[] val) {
957 int N = readInt();
958 if (N == val.length) {
959 for (int i=0; i<N; i++) {
960 val[i] = readString();
961 }
962 } else {
963 throw new RuntimeException("bad array lengths");
964 }
965 }
966
967 public final void writeBinderArray(IBinder[] val) {
968 if (val != null) {
969 int N = val.length;
970 writeInt(N);
971 for (int i=0; i<N; i++) {
972 writeStrongBinder(val[i]);
973 }
974 } else {
975 writeInt(-1);
976 }
977 }
978
Bjorn Bringert08bbffb2010-02-25 11:16:22 +0000979 /**
980 * @hide
981 */
982 public final void writeCharSequenceArray(CharSequence[] val) {
983 if (val != null) {
984 int N = val.length;
985 writeInt(N);
986 for (int i=0; i<N; i++) {
987 writeCharSequence(val[i]);
988 }
989 } else {
990 writeInt(-1);
991 }
992 }
993
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800994 public final IBinder[] createBinderArray() {
995 int N = readInt();
996 if (N >= 0) {
997 IBinder[] val = new IBinder[N];
998 for (int i=0; i<N; i++) {
999 val[i] = readStrongBinder();
1000 }
1001 return val;
1002 } else {
1003 return null;
1004 }
1005 }
1006
1007 public final void readBinderArray(IBinder[] val) {
1008 int N = readInt();
1009 if (N == val.length) {
1010 for (int i=0; i<N; i++) {
1011 val[i] = readStrongBinder();
1012 }
1013 } else {
1014 throw new RuntimeException("bad array lengths");
1015 }
1016 }
1017
1018 /**
1019 * Flatten a List containing a particular object type into the parcel, at
1020 * the current dataPosition() and growing dataCapacity() if needed. The
1021 * type of the objects in the list must be one that implements Parcelable.
1022 * Unlike the generic writeList() method, however, only the raw data of the
1023 * objects is written and not their type, so you must use the corresponding
1024 * readTypedList() to unmarshall them.
1025 *
1026 * @param val The list of objects to be written.
1027 *
1028 * @see #createTypedArrayList
1029 * @see #readTypedList
1030 * @see Parcelable
1031 */
1032 public final <T extends Parcelable> void writeTypedList(List<T> val) {
1033 if (val == null) {
1034 writeInt(-1);
1035 return;
1036 }
1037 int N = val.size();
1038 int i=0;
1039 writeInt(N);
1040 while (i < N) {
1041 T item = val.get(i);
1042 if (item != null) {
1043 writeInt(1);
1044 item.writeToParcel(this, 0);
1045 } else {
1046 writeInt(0);
1047 }
1048 i++;
1049 }
1050 }
1051
1052 /**
1053 * Flatten a List containing String objects into the parcel, at
1054 * the current dataPosition() and growing dataCapacity() if needed. They
1055 * can later be retrieved with {@link #createStringArrayList} or
1056 * {@link #readStringList}.
1057 *
1058 * @param val The list of strings to be written.
1059 *
1060 * @see #createStringArrayList
1061 * @see #readStringList
1062 */
1063 public final void writeStringList(List<String> val) {
1064 if (val == null) {
1065 writeInt(-1);
1066 return;
1067 }
1068 int N = val.size();
1069 int i=0;
1070 writeInt(N);
1071 while (i < N) {
1072 writeString(val.get(i));
1073 i++;
1074 }
1075 }
1076
1077 /**
1078 * Flatten a List containing IBinder objects into the parcel, at
1079 * the current dataPosition() and growing dataCapacity() if needed. They
1080 * can later be retrieved with {@link #createBinderArrayList} or
1081 * {@link #readBinderList}.
1082 *
1083 * @param val The list of strings to be written.
1084 *
1085 * @see #createBinderArrayList
1086 * @see #readBinderList
1087 */
1088 public final void writeBinderList(List<IBinder> val) {
1089 if (val == null) {
1090 writeInt(-1);
1091 return;
1092 }
1093 int N = val.size();
1094 int i=0;
1095 writeInt(N);
1096 while (i < N) {
1097 writeStrongBinder(val.get(i));
1098 i++;
1099 }
1100 }
1101
1102 /**
1103 * Flatten a heterogeneous array containing a particular object type into
1104 * the parcel, at
1105 * the current dataPosition() and growing dataCapacity() if needed. The
1106 * type of the objects in the array must be one that implements Parcelable.
1107 * Unlike the {@link #writeParcelableArray} method, however, only the
1108 * raw data of the objects is written and not their type, so you must use
1109 * {@link #readTypedArray} with the correct corresponding
1110 * {@link Parcelable.Creator} implementation to unmarshall them.
1111 *
1112 * @param val The array of objects to be written.
1113 * @param parcelableFlags Contextual flags as per
1114 * {@link Parcelable#writeToParcel(Parcel, int) Parcelable.writeToParcel()}.
1115 *
1116 * @see #readTypedArray
1117 * @see #writeParcelableArray
1118 * @see Parcelable.Creator
1119 */
1120 public final <T extends Parcelable> void writeTypedArray(T[] val,
1121 int parcelableFlags) {
1122 if (val != null) {
1123 int N = val.length;
1124 writeInt(N);
1125 for (int i=0; i<N; i++) {
1126 T item = val[i];
1127 if (item != null) {
1128 writeInt(1);
1129 item.writeToParcel(this, parcelableFlags);
1130 } else {
1131 writeInt(0);
1132 }
1133 }
1134 } else {
1135 writeInt(-1);
1136 }
1137 }
1138
1139 /**
1140 * Flatten a generic object in to a parcel. The given Object value may
1141 * currently be one of the following types:
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001142 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001143 * <ul>
1144 * <li> null
1145 * <li> String
1146 * <li> Byte
1147 * <li> Short
1148 * <li> Integer
1149 * <li> Long
1150 * <li> Float
1151 * <li> Double
1152 * <li> Boolean
1153 * <li> String[]
1154 * <li> boolean[]
1155 * <li> byte[]
1156 * <li> int[]
1157 * <li> long[]
1158 * <li> Object[] (supporting objects of the same type defined here).
1159 * <li> {@link Bundle}
1160 * <li> Map (as supported by {@link #writeMap}).
1161 * <li> Any object that implements the {@link Parcelable} protocol.
1162 * <li> Parcelable[]
1163 * <li> CharSequence (as supported by {@link TextUtils#writeToParcel}).
1164 * <li> List (as supported by {@link #writeList}).
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001165 * <li> {@link SparseArray} (as supported by {@link #writeSparseArray(SparseArray)}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001166 * <li> {@link IBinder}
1167 * <li> Any object that implements Serializable (but see
1168 * {@link #writeSerializable} for caveats). Note that all of the
1169 * previous types have relatively efficient implementations for
1170 * writing to a Parcel; having to rely on the generic serialization
1171 * approach is much less efficient and should be avoided whenever
1172 * possible.
1173 * </ul>
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001174 *
1175 * <p class="caution">{@link Parcelable} objects are written with
1176 * {@link Parcelable#writeToParcel} using contextual flags of 0. When
1177 * serializing objects containing {@link ParcelFileDescriptor}s,
1178 * this may result in file descriptor leaks when they are returned from
1179 * Binder calls (where {@link Parcelable#PARCELABLE_WRITE_RETURN_VALUE}
1180 * should be used).</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001181 */
1182 public final void writeValue(Object v) {
1183 if (v == null) {
1184 writeInt(VAL_NULL);
1185 } else if (v instanceof String) {
1186 writeInt(VAL_STRING);
1187 writeString((String) v);
1188 } else if (v instanceof Integer) {
1189 writeInt(VAL_INTEGER);
1190 writeInt((Integer) v);
1191 } else if (v instanceof Map) {
1192 writeInt(VAL_MAP);
1193 writeMap((Map) v);
1194 } else if (v instanceof Bundle) {
1195 // Must be before Parcelable
1196 writeInt(VAL_BUNDLE);
1197 writeBundle((Bundle) v);
1198 } else if (v instanceof Parcelable) {
1199 writeInt(VAL_PARCELABLE);
1200 writeParcelable((Parcelable) v, 0);
1201 } else if (v instanceof Short) {
1202 writeInt(VAL_SHORT);
1203 writeInt(((Short) v).intValue());
1204 } else if (v instanceof Long) {
1205 writeInt(VAL_LONG);
1206 writeLong((Long) v);
1207 } else if (v instanceof Float) {
1208 writeInt(VAL_FLOAT);
1209 writeFloat((Float) v);
1210 } else if (v instanceof Double) {
1211 writeInt(VAL_DOUBLE);
1212 writeDouble((Double) v);
1213 } else if (v instanceof Boolean) {
1214 writeInt(VAL_BOOLEAN);
1215 writeInt((Boolean) v ? 1 : 0);
1216 } else if (v instanceof CharSequence) {
1217 // Must be after String
1218 writeInt(VAL_CHARSEQUENCE);
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001219 writeCharSequence((CharSequence) v);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001220 } else if (v instanceof List) {
1221 writeInt(VAL_LIST);
1222 writeList((List) v);
1223 } else if (v instanceof SparseArray) {
1224 writeInt(VAL_SPARSEARRAY);
1225 writeSparseArray((SparseArray) v);
1226 } else if (v instanceof boolean[]) {
1227 writeInt(VAL_BOOLEANARRAY);
1228 writeBooleanArray((boolean[]) v);
1229 } else if (v instanceof byte[]) {
1230 writeInt(VAL_BYTEARRAY);
1231 writeByteArray((byte[]) v);
1232 } else if (v instanceof String[]) {
1233 writeInt(VAL_STRINGARRAY);
1234 writeStringArray((String[]) v);
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001235 } else if (v instanceof CharSequence[]) {
1236 // Must be after String[] and before Object[]
1237 writeInt(VAL_CHARSEQUENCEARRAY);
1238 writeCharSequenceArray((CharSequence[]) v);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001239 } else if (v instanceof IBinder) {
1240 writeInt(VAL_IBINDER);
1241 writeStrongBinder((IBinder) v);
1242 } else if (v instanceof Parcelable[]) {
1243 writeInt(VAL_PARCELABLEARRAY);
1244 writeParcelableArray((Parcelable[]) v, 0);
1245 } else if (v instanceof Object[]) {
1246 writeInt(VAL_OBJECTARRAY);
1247 writeArray((Object[]) v);
1248 } else if (v instanceof int[]) {
1249 writeInt(VAL_INTARRAY);
1250 writeIntArray((int[]) v);
1251 } else if (v instanceof long[]) {
1252 writeInt(VAL_LONGARRAY);
1253 writeLongArray((long[]) v);
1254 } else if (v instanceof Byte) {
1255 writeInt(VAL_BYTE);
1256 writeInt((Byte) v);
1257 } else if (v instanceof Serializable) {
1258 // Must be last
1259 writeInt(VAL_SERIALIZABLE);
1260 writeSerializable((Serializable) v);
1261 } else {
1262 throw new RuntimeException("Parcel: unable to marshal value " + v);
1263 }
1264 }
1265
1266 /**
1267 * Flatten the name of the class of the Parcelable and its contents
1268 * into the parcel.
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001269 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001270 * @param p The Parcelable object to be written.
1271 * @param parcelableFlags Contextual flags as per
1272 * {@link Parcelable#writeToParcel(Parcel, int) Parcelable.writeToParcel()}.
1273 */
1274 public final void writeParcelable(Parcelable p, int parcelableFlags) {
1275 if (p == null) {
1276 writeString(null);
1277 return;
1278 }
1279 String name = p.getClass().getName();
1280 writeString(name);
1281 p.writeToParcel(this, parcelableFlags);
1282 }
1283
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -08001284 /** @hide */
1285 public final void writeParcelableCreator(Parcelable p) {
1286 String name = p.getClass().getName();
1287 writeString(name);
1288 }
1289
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001290 /**
1291 * Write a generic serializable object in to a Parcel. It is strongly
1292 * recommended that this method be avoided, since the serialization
1293 * overhead is extremely large, and this approach will be much slower than
1294 * using the other approaches to writing data in to a Parcel.
1295 */
1296 public final void writeSerializable(Serializable s) {
1297 if (s == null) {
1298 writeString(null);
1299 return;
1300 }
1301 String name = s.getClass().getName();
1302 writeString(name);
1303
1304 ByteArrayOutputStream baos = new ByteArrayOutputStream();
1305 try {
1306 ObjectOutputStream oos = new ObjectOutputStream(baos);
1307 oos.writeObject(s);
1308 oos.close();
1309
1310 writeByteArray(baos.toByteArray());
1311 } catch (IOException ioe) {
1312 throw new RuntimeException("Parcelable encountered " +
1313 "IOException writing serializable object (name = " + name +
1314 ")", ioe);
1315 }
1316 }
1317
1318 /**
1319 * Special function for writing an exception result at the header of
1320 * a parcel, to be used when returning an exception from a transaction.
1321 * Note that this currently only supports a few exception types; any other
1322 * exception will be re-thrown by this function as a RuntimeException
1323 * (to be caught by the system's last-resort exception handling when
1324 * dispatching a transaction).
1325 *
1326 * <p>The supported exception types are:
1327 * <ul>
1328 * <li>{@link BadParcelableException}
1329 * <li>{@link IllegalArgumentException}
1330 * <li>{@link IllegalStateException}
1331 * <li>{@link NullPointerException}
1332 * <li>{@link SecurityException}
Dianne Hackborn7e714422013-09-13 17:32:57 -07001333 * <li>{@link NetworkOnMainThreadException}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001334 * </ul>
1335 *
1336 * @param e The Exception to be written.
1337 *
1338 * @see #writeNoException
1339 * @see #readException
1340 */
1341 public final void writeException(Exception e) {
1342 int code = 0;
1343 if (e instanceof SecurityException) {
1344 code = EX_SECURITY;
1345 } else if (e instanceof BadParcelableException) {
1346 code = EX_BAD_PARCELABLE;
1347 } else if (e instanceof IllegalArgumentException) {
1348 code = EX_ILLEGAL_ARGUMENT;
1349 } else if (e instanceof NullPointerException) {
1350 code = EX_NULL_POINTER;
1351 } else if (e instanceof IllegalStateException) {
1352 code = EX_ILLEGAL_STATE;
Dianne Hackborn7e714422013-09-13 17:32:57 -07001353 } else if (e instanceof NetworkOnMainThreadException) {
1354 code = EX_NETWORK_MAIN_THREAD;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001355 }
1356 writeInt(code);
Brad Fitzpatrick703e5d32010-07-15 13:16:41 -07001357 StrictMode.clearGatheredViolations();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001358 if (code == 0) {
1359 if (e instanceof RuntimeException) {
1360 throw (RuntimeException) e;
1361 }
1362 throw new RuntimeException(e);
1363 }
1364 writeString(e.getMessage());
1365 }
1366
1367 /**
1368 * Special function for writing information at the front of the Parcel
1369 * indicating that no exception occurred.
1370 *
1371 * @see #writeException
1372 * @see #readException
1373 */
1374 public final void writeNoException() {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07001375 // Despite the name of this function ("write no exception"),
1376 // it should instead be thought of as "write the RPC response
1377 // header", but because this function name is written out by
1378 // the AIDL compiler, we're not going to rename it.
1379 //
1380 // The response header, in the non-exception case (see also
1381 // writeException above, also called by the AIDL compiler), is
1382 // either a 0 (the default case), or EX_HAS_REPLY_HEADER if
1383 // StrictMode has gathered up violations that have occurred
1384 // during a Binder call, in which case we write out the number
1385 // of violations and their details, serialized, before the
1386 // actual RPC respons data. The receiving end of this is
1387 // readException(), below.
1388 if (StrictMode.hasGatheredViolations()) {
1389 writeInt(EX_HAS_REPLY_HEADER);
1390 final int sizePosition = dataPosition();
1391 writeInt(0); // total size of fat header, to be filled in later
1392 StrictMode.writeGatheredViolationsToParcel(this);
1393 final int payloadPosition = dataPosition();
1394 setDataPosition(sizePosition);
1395 writeInt(payloadPosition - sizePosition); // header size
1396 setDataPosition(payloadPosition);
1397 } else {
1398 writeInt(0);
1399 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001400 }
1401
1402 /**
1403 * Special function for reading an exception result from the header of
1404 * a parcel, to be used after receiving the result of a transaction. This
1405 * will throw the exception for you if it had been written to the Parcel,
1406 * otherwise return and let you read the normal result data from the Parcel.
1407 *
1408 * @see #writeException
1409 * @see #writeNoException
1410 */
1411 public final void readException() {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07001412 int code = readExceptionCode();
1413 if (code != 0) {
1414 String msg = readString();
1415 readException(code, msg);
1416 }
1417 }
1418
1419 /**
1420 * Parses the header of a Binder call's response Parcel and
1421 * returns the exception code. Deals with lite or fat headers.
1422 * In the common successful case, this header is generally zero.
1423 * In less common cases, it's a small negative number and will be
1424 * followed by an error string.
1425 *
1426 * This exists purely for android.database.DatabaseUtils and
1427 * insulating it from having to handle fat headers as returned by
1428 * e.g. StrictMode-induced RPC responses.
1429 *
1430 * @hide
1431 */
1432 public final int readExceptionCode() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001433 int code = readInt();
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07001434 if (code == EX_HAS_REPLY_HEADER) {
1435 int headerSize = readInt();
1436 if (headerSize == 0) {
1437 Log.e(TAG, "Unexpected zero-sized Parcel reply header.");
1438 } else {
1439 // Currently the only thing in the header is StrictMode stacks,
1440 // but discussions around event/RPC tracing suggest we might
1441 // put that here too. If so, switch on sub-header tags here.
1442 // But for now, just parse out the StrictMode stuff.
1443 StrictMode.readAndHandleBinderCallViolations(this);
1444 }
1445 // And fat response headers are currently only used when
1446 // there are no exceptions, so return no error:
1447 return 0;
1448 }
1449 return code;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001450 }
1451
1452 /**
1453 * Use this function for customized exception handling.
1454 * customized method call this method for all unknown case
1455 * @param code exception code
1456 * @param msg exception message
1457 */
1458 public final void readException(int code, String msg) {
1459 switch (code) {
1460 case EX_SECURITY:
1461 throw new SecurityException(msg);
1462 case EX_BAD_PARCELABLE:
1463 throw new BadParcelableException(msg);
1464 case EX_ILLEGAL_ARGUMENT:
1465 throw new IllegalArgumentException(msg);
1466 case EX_NULL_POINTER:
1467 throw new NullPointerException(msg);
1468 case EX_ILLEGAL_STATE:
1469 throw new IllegalStateException(msg);
Dianne Hackborn7e714422013-09-13 17:32:57 -07001470 case EX_NETWORK_MAIN_THREAD:
1471 throw new NetworkOnMainThreadException();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001472 }
1473 throw new RuntimeException("Unknown exception code: " + code
1474 + " msg " + msg);
1475 }
1476
1477 /**
1478 * Read an integer value from the parcel at the current dataPosition().
1479 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001480 public final int readInt() {
1481 return nativeReadInt(mNativePtr);
1482 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001483
1484 /**
1485 * Read a long integer value from the parcel at the current dataPosition().
1486 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001487 public final long readLong() {
1488 return nativeReadLong(mNativePtr);
1489 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001490
1491 /**
1492 * Read a floating point value from the parcel at the current
1493 * dataPosition().
1494 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001495 public final float readFloat() {
1496 return nativeReadFloat(mNativePtr);
1497 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001498
1499 /**
1500 * Read a double precision floating point value from the parcel at the
1501 * current dataPosition().
1502 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001503 public final double readDouble() {
1504 return nativeReadDouble(mNativePtr);
1505 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001506
1507 /**
1508 * Read a string value from the parcel at the current dataPosition().
1509 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001510 public final String readString() {
1511 return nativeReadString(mNativePtr);
1512 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001513
1514 /**
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001515 * Read a CharSequence value from the parcel at the current dataPosition().
1516 * @hide
1517 */
1518 public final CharSequence readCharSequence() {
1519 return TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(this);
1520 }
1521
1522 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001523 * Read an object from the parcel at the current dataPosition().
1524 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001525 public final IBinder readStrongBinder() {
1526 return nativeReadStrongBinder(mNativePtr);
1527 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001528
1529 /**
1530 * Read a FileDescriptor from the parcel at the current dataPosition().
1531 */
1532 public final ParcelFileDescriptor readFileDescriptor() {
Jeff Sharkey047238c2012-03-07 16:51:38 -08001533 FileDescriptor fd = nativeReadFileDescriptor(mNativePtr);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001534 return fd != null ? new ParcelFileDescriptor(fd) : null;
1535 }
1536
Jeff Sharkeyda5a3e12013-08-11 12:54:42 -07001537 /** {@hide} */
1538 public final FileDescriptor readRawFileDescriptor() {
1539 return nativeReadFileDescriptor(mNativePtr);
1540 }
1541
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001542 /*package*/ static native FileDescriptor openFileDescriptor(String file,
1543 int mode) throws FileNotFoundException;
Dianne Hackborn9a849832011-04-07 15:11:57 -07001544 /*package*/ static native FileDescriptor dupFileDescriptor(FileDescriptor orig)
1545 throws IOException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001546 /*package*/ static native void closeFileDescriptor(FileDescriptor desc)
1547 throws IOException;
Dianne Hackbornc9119f52011-02-28 18:03:26 -08001548 /*package*/ static native void clearFileDescriptor(FileDescriptor desc);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001549
1550 /**
1551 * Read a byte value from the parcel at the current dataPosition().
1552 */
1553 public final byte readByte() {
1554 return (byte)(readInt() & 0xff);
1555 }
1556
1557 /**
1558 * Please use {@link #readBundle(ClassLoader)} instead (whose data must have
1559 * been written with {@link #writeBundle}. Read into an existing Map object
1560 * from the parcel at the current dataPosition().
1561 */
1562 public final void readMap(Map outVal, ClassLoader loader) {
1563 int N = readInt();
1564 readMapInternal(outVal, N, loader);
1565 }
1566
1567 /**
1568 * Read into an existing List object from the parcel at the current
1569 * dataPosition(), using the given class loader to load any enclosed
1570 * Parcelables. If it is null, the default class loader is used.
1571 */
1572 public final void readList(List outVal, ClassLoader loader) {
1573 int N = readInt();
1574 readListInternal(outVal, N, loader);
1575 }
1576
1577 /**
1578 * Please use {@link #readBundle(ClassLoader)} instead (whose data must have
1579 * been written with {@link #writeBundle}. Read and return a new HashMap
1580 * object from the parcel at the current dataPosition(), using the given
1581 * class loader to load any enclosed Parcelables. Returns null if
1582 * the previously written map object was null.
1583 */
1584 public final HashMap readHashMap(ClassLoader loader)
1585 {
1586 int N = readInt();
1587 if (N < 0) {
1588 return null;
1589 }
1590 HashMap m = new HashMap(N);
1591 readMapInternal(m, N, loader);
1592 return m;
1593 }
1594
1595 /**
1596 * Read and return a new Bundle object from the parcel at the current
1597 * dataPosition(). Returns null if the previously written Bundle object was
1598 * null.
1599 */
1600 public final Bundle readBundle() {
1601 return readBundle(null);
1602 }
1603
1604 /**
1605 * Read and return a new Bundle object from the parcel at the current
1606 * dataPosition(), using the given class loader to initialize the class
1607 * loader of the Bundle for later retrieval of Parcelable objects.
1608 * Returns null if the previously written Bundle object was null.
1609 */
1610 public final Bundle readBundle(ClassLoader loader) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001611 int length = readInt();
1612 if (length < 0) {
1613 return null;
1614 }
Dianne Hackborn6aff9052009-05-22 13:20:23 -07001615
1616 final Bundle bundle = new Bundle(this, length);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 if (loader != null) {
1618 bundle.setClassLoader(loader);
1619 }
1620 return bundle;
1621 }
1622
1623 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001624 * Read and return a byte[] object from the parcel.
1625 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001626 public final byte[] createByteArray() {
1627 return nativeCreateByteArray(mNativePtr);
1628 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001629
1630 /**
1631 * Read a byte[] object from the parcel and copy it into the
1632 * given byte array.
1633 */
1634 public final void readByteArray(byte[] val) {
1635 // TODO: make this a native method to avoid the extra copy.
1636 byte[] ba = createByteArray();
1637 if (ba.length == val.length) {
1638 System.arraycopy(ba, 0, val, 0, ba.length);
1639 } else {
1640 throw new RuntimeException("bad array lengths");
1641 }
1642 }
1643
1644 /**
1645 * Read and return a String[] object from the parcel.
1646 * {@hide}
1647 */
1648 public final String[] readStringArray() {
1649 String[] array = null;
1650
1651 int length = readInt();
1652 if (length >= 0)
1653 {
1654 array = new String[length];
1655
1656 for (int i = 0 ; i < length ; i++)
1657 {
1658 array[i] = readString();
1659 }
1660 }
1661
1662 return array;
1663 }
1664
1665 /**
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001666 * Read and return a CharSequence[] object from the parcel.
1667 * {@hide}
1668 */
1669 public final CharSequence[] readCharSequenceArray() {
1670 CharSequence[] array = null;
1671
1672 int length = readInt();
1673 if (length >= 0)
1674 {
1675 array = new CharSequence[length];
1676
1677 for (int i = 0 ; i < length ; i++)
1678 {
1679 array[i] = readCharSequence();
1680 }
1681 }
1682
1683 return array;
1684 }
1685
1686 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001687 * Read and return a new ArrayList object from the parcel at the current
1688 * dataPosition(). Returns null if the previously written list object was
1689 * null. The given class loader will be used to load any enclosed
1690 * Parcelables.
1691 */
1692 public final ArrayList readArrayList(ClassLoader loader) {
1693 int N = readInt();
1694 if (N < 0) {
1695 return null;
1696 }
1697 ArrayList l = new ArrayList(N);
1698 readListInternal(l, N, loader);
1699 return l;
1700 }
1701
1702 /**
1703 * Read and return a new Object array from the parcel at the current
1704 * dataPosition(). Returns null if the previously written array was
1705 * null. The given class loader will be used to load any enclosed
1706 * Parcelables.
1707 */
1708 public final Object[] readArray(ClassLoader loader) {
1709 int N = readInt();
1710 if (N < 0) {
1711 return null;
1712 }
1713 Object[] l = new Object[N];
1714 readArrayInternal(l, N, loader);
1715 return l;
1716 }
1717
1718 /**
1719 * Read and return a new SparseArray object from the parcel at the current
1720 * dataPosition(). Returns null if the previously written list object was
1721 * null. The given class loader will be used to load any enclosed
1722 * Parcelables.
1723 */
1724 public final SparseArray readSparseArray(ClassLoader loader) {
1725 int N = readInt();
1726 if (N < 0) {
1727 return null;
1728 }
1729 SparseArray sa = new SparseArray(N);
1730 readSparseArrayInternal(sa, N, loader);
1731 return sa;
1732 }
1733
1734 /**
1735 * Read and return a new SparseBooleanArray object from the parcel at the current
1736 * dataPosition(). Returns null if the previously written list object was
1737 * null.
1738 */
1739 public final SparseBooleanArray readSparseBooleanArray() {
1740 int N = readInt();
1741 if (N < 0) {
1742 return null;
1743 }
1744 SparseBooleanArray sa = new SparseBooleanArray(N);
1745 readSparseBooleanArrayInternal(sa, N);
1746 return sa;
1747 }
1748
1749 /**
1750 * Read and return a new ArrayList containing a particular object type from
1751 * the parcel that was written with {@link #writeTypedList} at the
1752 * current dataPosition(). Returns null if the
1753 * previously written list object was null. The list <em>must</em> have
1754 * previously been written via {@link #writeTypedList} with the same object
1755 * type.
1756 *
1757 * @return A newly created ArrayList containing objects with the same data
1758 * as those that were previously written.
1759 *
1760 * @see #writeTypedList
1761 */
1762 public final <T> ArrayList<T> createTypedArrayList(Parcelable.Creator<T> c) {
1763 int N = readInt();
1764 if (N < 0) {
1765 return null;
1766 }
1767 ArrayList<T> l = new ArrayList<T>(N);
1768 while (N > 0) {
1769 if (readInt() != 0) {
1770 l.add(c.createFromParcel(this));
1771 } else {
1772 l.add(null);
1773 }
1774 N--;
1775 }
1776 return l;
1777 }
1778
1779 /**
1780 * Read into the given List items containing a particular object type
1781 * that were written with {@link #writeTypedList} at the
1782 * current dataPosition(). The list <em>must</em> have
1783 * previously been written via {@link #writeTypedList} with the same object
1784 * type.
1785 *
1786 * @return A newly created ArrayList containing objects with the same data
1787 * as those that were previously written.
1788 *
1789 * @see #writeTypedList
1790 */
1791 public final <T> void readTypedList(List<T> list, Parcelable.Creator<T> c) {
1792 int M = list.size();
1793 int N = readInt();
1794 int i = 0;
1795 for (; i < M && i < N; i++) {
1796 if (readInt() != 0) {
1797 list.set(i, c.createFromParcel(this));
1798 } else {
1799 list.set(i, null);
1800 }
1801 }
1802 for (; i<N; i++) {
1803 if (readInt() != 0) {
1804 list.add(c.createFromParcel(this));
1805 } else {
1806 list.add(null);
1807 }
1808 }
1809 for (; i<M; i++) {
1810 list.remove(N);
1811 }
1812 }
1813
1814 /**
1815 * Read and return a new ArrayList containing String objects from
1816 * the parcel that was written with {@link #writeStringList} at the
1817 * current dataPosition(). Returns null if the
1818 * previously written list object was null.
1819 *
1820 * @return A newly created ArrayList containing strings with the same data
1821 * as those that were previously written.
1822 *
1823 * @see #writeStringList
1824 */
1825 public final ArrayList<String> createStringArrayList() {
1826 int N = readInt();
1827 if (N < 0) {
1828 return null;
1829 }
1830 ArrayList<String> l = new ArrayList<String>(N);
1831 while (N > 0) {
1832 l.add(readString());
1833 N--;
1834 }
1835 return l;
1836 }
1837
1838 /**
1839 * Read and return a new ArrayList containing IBinder objects from
1840 * the parcel that was written with {@link #writeBinderList} at the
1841 * current dataPosition(). Returns null if the
1842 * previously written list object was null.
1843 *
1844 * @return A newly created ArrayList containing strings with the same data
1845 * as those that were previously written.
1846 *
1847 * @see #writeBinderList
1848 */
1849 public final ArrayList<IBinder> createBinderArrayList() {
1850 int N = readInt();
1851 if (N < 0) {
1852 return null;
1853 }
1854 ArrayList<IBinder> l = new ArrayList<IBinder>(N);
1855 while (N > 0) {
1856 l.add(readStrongBinder());
1857 N--;
1858 }
1859 return l;
1860 }
1861
1862 /**
1863 * Read into the given List items String objects that were written with
1864 * {@link #writeStringList} at the current dataPosition().
1865 *
1866 * @return A newly created ArrayList containing strings with the same data
1867 * as those that were previously written.
1868 *
1869 * @see #writeStringList
1870 */
1871 public final void readStringList(List<String> list) {
1872 int M = list.size();
1873 int N = readInt();
1874 int i = 0;
1875 for (; i < M && i < N; i++) {
1876 list.set(i, readString());
1877 }
1878 for (; i<N; i++) {
1879 list.add(readString());
1880 }
1881 for (; i<M; i++) {
1882 list.remove(N);
1883 }
1884 }
1885
1886 /**
1887 * Read into the given List items IBinder objects that were written with
1888 * {@link #writeBinderList} at the current dataPosition().
1889 *
1890 * @return A newly created ArrayList containing strings with the same data
1891 * as those that were previously written.
1892 *
1893 * @see #writeBinderList
1894 */
1895 public final void readBinderList(List<IBinder> list) {
1896 int M = list.size();
1897 int N = readInt();
1898 int i = 0;
1899 for (; i < M && i < N; i++) {
1900 list.set(i, readStrongBinder());
1901 }
1902 for (; i<N; i++) {
1903 list.add(readStrongBinder());
1904 }
1905 for (; i<M; i++) {
1906 list.remove(N);
1907 }
1908 }
1909
1910 /**
1911 * Read and return a new array containing a particular object type from
1912 * the parcel at the current dataPosition(). Returns null if the
1913 * previously written array was null. The array <em>must</em> have
1914 * previously been written via {@link #writeTypedArray} with the same
1915 * object type.
1916 *
1917 * @return A newly created array containing objects with the same data
1918 * as those that were previously written.
1919 *
1920 * @see #writeTypedArray
1921 */
1922 public final <T> T[] createTypedArray(Parcelable.Creator<T> c) {
1923 int N = readInt();
1924 if (N < 0) {
1925 return null;
1926 }
1927 T[] l = c.newArray(N);
1928 for (int i=0; i<N; i++) {
1929 if (readInt() != 0) {
1930 l[i] = c.createFromParcel(this);
1931 }
1932 }
1933 return l;
1934 }
1935
1936 public final <T> void readTypedArray(T[] val, Parcelable.Creator<T> c) {
1937 int N = readInt();
1938 if (N == val.length) {
1939 for (int i=0; i<N; i++) {
1940 if (readInt() != 0) {
1941 val[i] = c.createFromParcel(this);
1942 } else {
1943 val[i] = null;
1944 }
1945 }
1946 } else {
1947 throw new RuntimeException("bad array lengths");
1948 }
1949 }
1950
1951 /**
1952 * @deprecated
1953 * @hide
1954 */
1955 @Deprecated
1956 public final <T> T[] readTypedArray(Parcelable.Creator<T> c) {
1957 return createTypedArray(c);
1958 }
1959
1960 /**
1961 * Write a heterogeneous array of Parcelable objects into the Parcel.
1962 * Each object in the array is written along with its class name, so
1963 * that the correct class can later be instantiated. As a result, this
1964 * has significantly more overhead than {@link #writeTypedArray}, but will
1965 * correctly handle an array containing more than one type of object.
1966 *
1967 * @param value The array of objects to be written.
1968 * @param parcelableFlags Contextual flags as per
1969 * {@link Parcelable#writeToParcel(Parcel, int) Parcelable.writeToParcel()}.
1970 *
1971 * @see #writeTypedArray
1972 */
1973 public final <T extends Parcelable> void writeParcelableArray(T[] value,
1974 int parcelableFlags) {
1975 if (value != null) {
1976 int N = value.length;
1977 writeInt(N);
1978 for (int i=0; i<N; i++) {
1979 writeParcelable(value[i], parcelableFlags);
1980 }
1981 } else {
1982 writeInt(-1);
1983 }
1984 }
1985
1986 /**
1987 * Read a typed object from a parcel. The given class loader will be
1988 * used to load any enclosed Parcelables. If it is null, the default class
1989 * loader will be used.
1990 */
1991 public final Object readValue(ClassLoader loader) {
1992 int type = readInt();
1993
1994 switch (type) {
1995 case VAL_NULL:
1996 return null;
1997
1998 case VAL_STRING:
1999 return readString();
2000
2001 case VAL_INTEGER:
2002 return readInt();
2003
2004 case VAL_MAP:
2005 return readHashMap(loader);
2006
2007 case VAL_PARCELABLE:
2008 return readParcelable(loader);
2009
2010 case VAL_SHORT:
2011 return (short) readInt();
2012
2013 case VAL_LONG:
2014 return readLong();
2015
2016 case VAL_FLOAT:
2017 return readFloat();
2018
2019 case VAL_DOUBLE:
2020 return readDouble();
2021
2022 case VAL_BOOLEAN:
2023 return readInt() == 1;
2024
2025 case VAL_CHARSEQUENCE:
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00002026 return readCharSequence();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027
2028 case VAL_LIST:
2029 return readArrayList(loader);
2030
2031 case VAL_BOOLEANARRAY:
2032 return createBooleanArray();
2033
2034 case VAL_BYTEARRAY:
2035 return createByteArray();
2036
2037 case VAL_STRINGARRAY:
2038 return readStringArray();
2039
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00002040 case VAL_CHARSEQUENCEARRAY:
2041 return readCharSequenceArray();
2042
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002043 case VAL_IBINDER:
2044 return readStrongBinder();
2045
2046 case VAL_OBJECTARRAY:
2047 return readArray(loader);
2048
2049 case VAL_INTARRAY:
2050 return createIntArray();
2051
2052 case VAL_LONGARRAY:
2053 return createLongArray();
2054
2055 case VAL_BYTE:
2056 return readByte();
2057
2058 case VAL_SERIALIZABLE:
2059 return readSerializable();
2060
2061 case VAL_PARCELABLEARRAY:
2062 return readParcelableArray(loader);
2063
2064 case VAL_SPARSEARRAY:
2065 return readSparseArray(loader);
2066
2067 case VAL_SPARSEBOOLEANARRAY:
2068 return readSparseBooleanArray();
2069
2070 case VAL_BUNDLE:
2071 return readBundle(loader); // loading will be deferred
2072
2073 default:
2074 int off = dataPosition() - 4;
2075 throw new RuntimeException(
2076 "Parcel " + this + ": Unmarshalling unknown type code " + type + " at offset " + off);
2077 }
2078 }
2079
2080 /**
2081 * Read and return a new Parcelable from the parcel. The given class loader
2082 * will be used to load any enclosed Parcelables. If it is null, the default
2083 * class loader will be used.
2084 * @param loader A ClassLoader from which to instantiate the Parcelable
2085 * object, or null for the default class loader.
2086 * @return Returns the newly created Parcelable, or null if a null
2087 * object has been written.
2088 * @throws BadParcelableException Throws BadParcelableException if there
2089 * was an error trying to instantiate the Parcelable.
2090 */
2091 public final <T extends Parcelable> T readParcelable(ClassLoader loader) {
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -08002092 Parcelable.Creator<T> creator = readParcelableCreator(loader);
2093 if (creator == null) {
2094 return null;
2095 }
2096 if (creator instanceof Parcelable.ClassLoaderCreator<?>) {
2097 return ((Parcelable.ClassLoaderCreator<T>)creator).createFromParcel(this, loader);
2098 }
2099 return creator.createFromParcel(this);
2100 }
2101
2102 /** @hide */
2103 public final <T extends Parcelable> T readCreator(Parcelable.Creator<T> creator,
2104 ClassLoader loader) {
2105 if (creator instanceof Parcelable.ClassLoaderCreator<?>) {
2106 return ((Parcelable.ClassLoaderCreator<T>)creator).createFromParcel(this, loader);
2107 }
2108 return creator.createFromParcel(this);
2109 }
2110
2111 /** @hide */
2112 public final <T extends Parcelable> Parcelable.Creator<T> readParcelableCreator(
2113 ClassLoader loader) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002114 String name = readString();
2115 if (name == null) {
2116 return null;
2117 }
2118 Parcelable.Creator<T> creator;
2119 synchronized (mCreators) {
2120 HashMap<String,Parcelable.Creator> map = mCreators.get(loader);
2121 if (map == null) {
2122 map = new HashMap<String,Parcelable.Creator>();
2123 mCreators.put(loader, map);
2124 }
2125 creator = map.get(name);
2126 if (creator == null) {
2127 try {
2128 Class c = loader == null ?
2129 Class.forName(name) : Class.forName(name, true, loader);
2130 Field f = c.getField("CREATOR");
2131 creator = (Parcelable.Creator)f.get(null);
2132 }
2133 catch (IllegalAccessException e) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002134 Log.e(TAG, "Illegal access when unmarshalling: "
2135 + name, e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 throw new BadParcelableException(
2137 "IllegalAccessException when unmarshalling: " + name);
2138 }
2139 catch (ClassNotFoundException e) {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002140 Log.e(TAG, "Class not found when unmarshalling: "
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002141 + name, e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002142 throw new BadParcelableException(
2143 "ClassNotFoundException when unmarshalling: " + name);
2144 }
2145 catch (ClassCastException e) {
2146 throw new BadParcelableException("Parcelable protocol requires a "
2147 + "Parcelable.Creator object called "
2148 + " CREATOR on class " + name);
2149 }
2150 catch (NoSuchFieldException e) {
2151 throw new BadParcelableException("Parcelable protocol requires a "
2152 + "Parcelable.Creator object called "
2153 + " CREATOR on class " + name);
2154 }
Irfan Sheriff97a72f62013-01-11 10:45:51 -08002155 catch (NullPointerException e) {
2156 throw new BadParcelableException("Parcelable protocol requires "
2157 + "the CREATOR object to be static on class " + name);
2158 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002159 if (creator == null) {
2160 throw new BadParcelableException("Parcelable protocol requires a "
2161 + "Parcelable.Creator object called "
2162 + " CREATOR on class " + name);
2163 }
2164
2165 map.put(name, creator);
2166 }
2167 }
2168
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -08002169 return creator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002170 }
2171
2172 /**
2173 * Read and return a new Parcelable array from the parcel.
2174 * The given class loader will be used to load any enclosed
2175 * Parcelables.
2176 * @return the Parcelable array, or null if the array is null
2177 */
2178 public final Parcelable[] readParcelableArray(ClassLoader loader) {
2179 int N = readInt();
2180 if (N < 0) {
2181 return null;
2182 }
2183 Parcelable[] p = new Parcelable[N];
2184 for (int i = 0; i < N; i++) {
2185 p[i] = (Parcelable) readParcelable(loader);
2186 }
2187 return p;
2188 }
2189
2190 /**
2191 * Read and return a new Serializable object from the parcel.
2192 * @return the Serializable object, or null if the Serializable name
2193 * wasn't found in the parcel.
2194 */
2195 public final Serializable readSerializable() {
2196 String name = readString();
2197 if (name == null) {
2198 // For some reason we were unable to read the name of the Serializable (either there
2199 // is nothing left in the Parcel to read, or the next value wasn't a String), so
2200 // return null, which indicates that the name wasn't found in the parcel.
2201 return null;
2202 }
2203
2204 byte[] serializedData = createByteArray();
2205 ByteArrayInputStream bais = new ByteArrayInputStream(serializedData);
2206 try {
2207 ObjectInputStream ois = new ObjectInputStream(bais);
2208 return (Serializable) ois.readObject();
2209 } catch (IOException ioe) {
2210 throw new RuntimeException("Parcelable encountered " +
2211 "IOException reading a Serializable object (name = " + name +
2212 ")", ioe);
2213 } catch (ClassNotFoundException cnfe) {
2214 throw new RuntimeException("Parcelable encountered" +
2215 "ClassNotFoundException reading a Serializable object (name = "
2216 + name + ")", cnfe);
2217 }
2218 }
2219
2220 // Cache of previously looked up CREATOR.createFromParcel() methods for
2221 // particular classes. Keys are the names of the classes, values are
2222 // Method objects.
2223 private static final HashMap<ClassLoader,HashMap<String,Parcelable.Creator>>
2224 mCreators = new HashMap<ClassLoader,HashMap<String,Parcelable.Creator>>();
2225
2226 static protected final Parcel obtain(int obj) {
2227 final Parcel[] pool = sHolderPool;
2228 synchronized (pool) {
2229 Parcel p;
2230 for (int i=0; i<POOL_SIZE; i++) {
2231 p = pool[i];
2232 if (p != null) {
2233 pool[i] = null;
2234 if (DEBUG_RECYCLE) {
2235 p.mStack = new RuntimeException();
2236 }
2237 p.init(obj);
2238 return p;
2239 }
2240 }
2241 }
2242 return new Parcel(obj);
2243 }
2244
Jeff Sharkey047238c2012-03-07 16:51:38 -08002245 private Parcel(int nativePtr) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002246 if (DEBUG_RECYCLE) {
2247 mStack = new RuntimeException();
2248 }
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002249 //Log.i(TAG, "Initializing obj=0x" + Integer.toHexString(obj), mStack);
Jeff Sharkey047238c2012-03-07 16:51:38 -08002250 init(nativePtr);
2251 }
2252
2253 private void init(int nativePtr) {
2254 if (nativePtr != 0) {
2255 mNativePtr = nativePtr;
2256 mOwnsNativeParcelObject = false;
2257 } else {
2258 mNativePtr = nativeCreate();
2259 mOwnsNativeParcelObject = true;
2260 }
2261 }
2262
2263 private void freeBuffer() {
2264 if (mOwnsNativeParcelObject) {
2265 nativeFreeBuffer(mNativePtr);
2266 }
2267 }
2268
2269 private void destroy() {
2270 if (mNativePtr != 0) {
2271 if (mOwnsNativeParcelObject) {
2272 nativeDestroy(mNativePtr);
2273 }
2274 mNativePtr = 0;
2275 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002276 }
2277
2278 @Override
2279 protected void finalize() throws Throwable {
2280 if (DEBUG_RECYCLE) {
2281 if (mStack != null) {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002282 Log.w(TAG, "Client did not call Parcel.recycle()", mStack);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002283 }
2284 }
2285 destroy();
2286 }
2287
Dianne Hackborn6aff9052009-05-22 13:20:23 -07002288 /* package */ void readMapInternal(Map outVal, int N,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002289 ClassLoader loader) {
2290 while (N > 0) {
2291 Object key = readValue(loader);
2292 Object value = readValue(loader);
2293 outVal.put(key, value);
2294 N--;
2295 }
2296 }
2297
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002298 /* package */ void readArrayMapInternal(ArrayMap outVal, int N,
2299 ClassLoader loader) {
Dianne Hackborne784d1e2013-09-20 18:13:52 -07002300 if (DEBUG_ARRAY_MAP) {
2301 RuntimeException here = new RuntimeException("here");
2302 here.fillInStackTrace();
2303 Log.d(TAG, "Reading " + N + " ArrayMap entries", here);
2304 }
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002305 while (N > 0) {
2306 Object key = readValue(loader);
Dianne Hackborne784d1e2013-09-20 18:13:52 -07002307 if (DEBUG_ARRAY_MAP) Log.d(TAG, " Read #" + (N-1) + ": key=0x"
2308 + (key != null ? key.hashCode() : 0) + " " + key);
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002309 Object value = readValue(loader);
2310 outVal.append(key, value);
2311 N--;
2312 }
2313 }
2314
Dianne Hackborne784d1e2013-09-20 18:13:52 -07002315 /* package */ void readArrayMapSafelyInternal(ArrayMap outVal, int N,
2316 ClassLoader loader) {
2317 if (DEBUG_ARRAY_MAP) {
2318 RuntimeException here = new RuntimeException("here");
2319 here.fillInStackTrace();
2320 Log.d(TAG, "Reading safely " + N + " ArrayMap entries", here);
2321 }
2322 while (N > 0) {
2323 Object key = readValue(loader);
2324 if (DEBUG_ARRAY_MAP) Log.d(TAG, " Read safe #" + (N-1) + ": key=0x"
2325 + (key != null ? key.hashCode() : 0) + " " + key);
2326 Object value = readValue(loader);
2327 outVal.put(key, value);
2328 N--;
2329 }
2330 }
2331
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002332 private void readListInternal(List outVal, int N,
2333 ClassLoader loader) {
2334 while (N > 0) {
2335 Object value = readValue(loader);
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002336 //Log.d(TAG, "Unmarshalling value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002337 outVal.add(value);
2338 N--;
2339 }
2340 }
2341
2342 private void readArrayInternal(Object[] outVal, int N,
2343 ClassLoader loader) {
2344 for (int i = 0; i < N; i++) {
2345 Object value = readValue(loader);
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002346 //Log.d(TAG, "Unmarshalling value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002347 outVal[i] = value;
2348 }
2349 }
2350
2351 private void readSparseArrayInternal(SparseArray outVal, int N,
2352 ClassLoader loader) {
2353 while (N > 0) {
2354 int key = readInt();
2355 Object value = readValue(loader);
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002356 //Log.i(TAG, "Unmarshalling key=" + key + " value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002357 outVal.append(key, value);
2358 N--;
2359 }
2360 }
2361
2362
2363 private void readSparseBooleanArrayInternal(SparseBooleanArray outVal, int N) {
2364 while (N > 0) {
2365 int key = readInt();
2366 boolean value = this.readByte() == 1;
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002367 //Log.i(TAG, "Unmarshalling key=" + key + " value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002368 outVal.append(key, value);
2369 N--;
2370 }
2371 }
2372}