blob: 51e46bc3a9fd855d82c5bb45f7dc5745bbbbe858 [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 Hackborn8aee64d2013-10-25 10:41:50 -0700614 int startPos;
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700615 for (int i=0; i<N; i++) {
Dianne Hackborn8aee64d2013-10-25 10:41:50 -0700616 if (DEBUG_ARRAY_MAP) startPos = dataPosition();
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700617 writeValue(val.keyAt(i));
618 writeValue(val.valueAt(i));
Dianne Hackborn8aee64d2013-10-25 10:41:50 -0700619 if (DEBUG_ARRAY_MAP) Log.d(TAG, " Write #" + i + " "
620 + (dataPosition()-startPos) + " bytes: key=0x"
621 + Integer.toHexString(val.keyAt(i) != null ? val.keyAt(i).hashCode() : 0)
622 + " " + val.keyAt(i));
Dianne Hackbornb87655b2013-07-17 19:06:22 -0700623 }
624 }
625
626 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800627 * Flatten a Bundle into the parcel at the current dataPosition(),
628 * growing dataCapacity() if needed.
629 */
630 public final void writeBundle(Bundle val) {
631 if (val == null) {
632 writeInt(-1);
633 return;
634 }
635
Dianne Hackborn6aff9052009-05-22 13:20:23 -0700636 val.writeToParcel(this, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800637 }
638
639 /**
640 * Flatten a List into the parcel at the current dataPosition(), growing
641 * dataCapacity() if needed. The List values are written using
642 * {@link #writeValue} and must follow the specification there.
643 */
644 public final void writeList(List val) {
645 if (val == null) {
646 writeInt(-1);
647 return;
648 }
649 int N = val.size();
650 int i=0;
651 writeInt(N);
652 while (i < N) {
653 writeValue(val.get(i));
654 i++;
655 }
656 }
657
658 /**
659 * Flatten an Object array into the parcel at the current dataPosition(),
660 * growing dataCapacity() if needed. The array values are written using
661 * {@link #writeValue} and must follow the specification there.
662 */
663 public final void writeArray(Object[] val) {
664 if (val == null) {
665 writeInt(-1);
666 return;
667 }
668 int N = val.length;
669 int i=0;
670 writeInt(N);
671 while (i < N) {
672 writeValue(val[i]);
673 i++;
674 }
675 }
676
677 /**
678 * Flatten a generic SparseArray into the parcel at the current
679 * dataPosition(), growing dataCapacity() if needed. The SparseArray
680 * values are written using {@link #writeValue} and must follow the
681 * specification there.
682 */
683 public final void writeSparseArray(SparseArray<Object> val) {
684 if (val == null) {
685 writeInt(-1);
686 return;
687 }
688 int N = val.size();
689 writeInt(N);
690 int i=0;
691 while (i < N) {
692 writeInt(val.keyAt(i));
693 writeValue(val.valueAt(i));
694 i++;
695 }
696 }
697
698 public final void writeSparseBooleanArray(SparseBooleanArray val) {
699 if (val == null) {
700 writeInt(-1);
701 return;
702 }
703 int N = val.size();
704 writeInt(N);
705 int i=0;
706 while (i < N) {
707 writeInt(val.keyAt(i));
708 writeByte((byte)(val.valueAt(i) ? 1 : 0));
709 i++;
710 }
711 }
712
713 public final void writeBooleanArray(boolean[] val) {
714 if (val != null) {
715 int N = val.length;
716 writeInt(N);
717 for (int i=0; i<N; i++) {
718 writeInt(val[i] ? 1 : 0);
719 }
720 } else {
721 writeInt(-1);
722 }
723 }
724
725 public final boolean[] createBooleanArray() {
726 int N = readInt();
727 // >>2 as a fast divide-by-4 works in the create*Array() functions
728 // because dataAvail() will never return a negative number. 4 is
729 // the size of a stored boolean in the stream.
730 if (N >= 0 && N <= (dataAvail() >> 2)) {
731 boolean[] val = new boolean[N];
732 for (int i=0; i<N; i++) {
733 val[i] = readInt() != 0;
734 }
735 return val;
736 } else {
737 return null;
738 }
739 }
740
741 public final void readBooleanArray(boolean[] val) {
742 int N = readInt();
743 if (N == val.length) {
744 for (int i=0; i<N; i++) {
745 val[i] = readInt() != 0;
746 }
747 } else {
748 throw new RuntimeException("bad array lengths");
749 }
750 }
751
752 public final void writeCharArray(char[] val) {
753 if (val != null) {
754 int N = val.length;
755 writeInt(N);
756 for (int i=0; i<N; i++) {
757 writeInt((int)val[i]);
758 }
759 } else {
760 writeInt(-1);
761 }
762 }
763
764 public final char[] createCharArray() {
765 int N = readInt();
766 if (N >= 0 && N <= (dataAvail() >> 2)) {
767 char[] val = new char[N];
768 for (int i=0; i<N; i++) {
769 val[i] = (char)readInt();
770 }
771 return val;
772 } else {
773 return null;
774 }
775 }
776
777 public final void readCharArray(char[] val) {
778 int N = readInt();
779 if (N == val.length) {
780 for (int i=0; i<N; i++) {
781 val[i] = (char)readInt();
782 }
783 } else {
784 throw new RuntimeException("bad array lengths");
785 }
786 }
787
788 public final void writeIntArray(int[] val) {
789 if (val != null) {
790 int N = val.length;
791 writeInt(N);
792 for (int i=0; i<N; i++) {
793 writeInt(val[i]);
794 }
795 } else {
796 writeInt(-1);
797 }
798 }
799
800 public final int[] createIntArray() {
801 int N = readInt();
802 if (N >= 0 && N <= (dataAvail() >> 2)) {
803 int[] val = new int[N];
804 for (int i=0; i<N; i++) {
805 val[i] = readInt();
806 }
807 return val;
808 } else {
809 return null;
810 }
811 }
812
813 public final void readIntArray(int[] val) {
814 int N = readInt();
815 if (N == val.length) {
816 for (int i=0; i<N; i++) {
817 val[i] = readInt();
818 }
819 } else {
820 throw new RuntimeException("bad array lengths");
821 }
822 }
823
824 public final void writeLongArray(long[] val) {
825 if (val != null) {
826 int N = val.length;
827 writeInt(N);
828 for (int i=0; i<N; i++) {
829 writeLong(val[i]);
830 }
831 } else {
832 writeInt(-1);
833 }
834 }
835
836 public final long[] createLongArray() {
837 int N = readInt();
838 // >>3 because stored longs are 64 bits
839 if (N >= 0 && N <= (dataAvail() >> 3)) {
840 long[] val = new long[N];
841 for (int i=0; i<N; i++) {
842 val[i] = readLong();
843 }
844 return val;
845 } else {
846 return null;
847 }
848 }
849
850 public final void readLongArray(long[] val) {
851 int N = readInt();
852 if (N == val.length) {
853 for (int i=0; i<N; i++) {
854 val[i] = readLong();
855 }
856 } else {
857 throw new RuntimeException("bad array lengths");
858 }
859 }
860
861 public final void writeFloatArray(float[] val) {
862 if (val != null) {
863 int N = val.length;
864 writeInt(N);
865 for (int i=0; i<N; i++) {
866 writeFloat(val[i]);
867 }
868 } else {
869 writeInt(-1);
870 }
871 }
872
873 public final float[] createFloatArray() {
874 int N = readInt();
875 // >>2 because stored floats are 4 bytes
876 if (N >= 0 && N <= (dataAvail() >> 2)) {
877 float[] val = new float[N];
878 for (int i=0; i<N; i++) {
879 val[i] = readFloat();
880 }
881 return val;
882 } else {
883 return null;
884 }
885 }
886
887 public final void readFloatArray(float[] val) {
888 int N = readInt();
889 if (N == val.length) {
890 for (int i=0; i<N; i++) {
891 val[i] = readFloat();
892 }
893 } else {
894 throw new RuntimeException("bad array lengths");
895 }
896 }
897
898 public final void writeDoubleArray(double[] val) {
899 if (val != null) {
900 int N = val.length;
901 writeInt(N);
902 for (int i=0; i<N; i++) {
903 writeDouble(val[i]);
904 }
905 } else {
906 writeInt(-1);
907 }
908 }
909
910 public final double[] createDoubleArray() {
911 int N = readInt();
912 // >>3 because stored doubles are 8 bytes
913 if (N >= 0 && N <= (dataAvail() >> 3)) {
914 double[] val = new double[N];
915 for (int i=0; i<N; i++) {
916 val[i] = readDouble();
917 }
918 return val;
919 } else {
920 return null;
921 }
922 }
923
924 public final void readDoubleArray(double[] val) {
925 int N = readInt();
926 if (N == val.length) {
927 for (int i=0; i<N; i++) {
928 val[i] = readDouble();
929 }
930 } else {
931 throw new RuntimeException("bad array lengths");
932 }
933 }
934
935 public final void writeStringArray(String[] val) {
936 if (val != null) {
937 int N = val.length;
938 writeInt(N);
939 for (int i=0; i<N; i++) {
940 writeString(val[i]);
941 }
942 } else {
943 writeInt(-1);
944 }
945 }
946
947 public final String[] createStringArray() {
948 int N = readInt();
949 if (N >= 0) {
950 String[] val = new String[N];
951 for (int i=0; i<N; i++) {
952 val[i] = readString();
953 }
954 return val;
955 } else {
956 return null;
957 }
958 }
959
960 public final void readStringArray(String[] val) {
961 int N = readInt();
962 if (N == val.length) {
963 for (int i=0; i<N; i++) {
964 val[i] = readString();
965 }
966 } else {
967 throw new RuntimeException("bad array lengths");
968 }
969 }
970
971 public final void writeBinderArray(IBinder[] val) {
972 if (val != null) {
973 int N = val.length;
974 writeInt(N);
975 for (int i=0; i<N; i++) {
976 writeStrongBinder(val[i]);
977 }
978 } else {
979 writeInt(-1);
980 }
981 }
982
Bjorn Bringert08bbffb2010-02-25 11:16:22 +0000983 /**
984 * @hide
985 */
986 public final void writeCharSequenceArray(CharSequence[] val) {
987 if (val != null) {
988 int N = val.length;
989 writeInt(N);
990 for (int i=0; i<N; i++) {
991 writeCharSequence(val[i]);
992 }
993 } else {
994 writeInt(-1);
995 }
996 }
997
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800998 public final IBinder[] createBinderArray() {
999 int N = readInt();
1000 if (N >= 0) {
1001 IBinder[] val = new IBinder[N];
1002 for (int i=0; i<N; i++) {
1003 val[i] = readStrongBinder();
1004 }
1005 return val;
1006 } else {
1007 return null;
1008 }
1009 }
1010
1011 public final void readBinderArray(IBinder[] val) {
1012 int N = readInt();
1013 if (N == val.length) {
1014 for (int i=0; i<N; i++) {
1015 val[i] = readStrongBinder();
1016 }
1017 } else {
1018 throw new RuntimeException("bad array lengths");
1019 }
1020 }
1021
1022 /**
1023 * Flatten a List containing a particular object type into the parcel, at
1024 * the current dataPosition() and growing dataCapacity() if needed. The
1025 * type of the objects in the list must be one that implements Parcelable.
1026 * Unlike the generic writeList() method, however, only the raw data of the
1027 * objects is written and not their type, so you must use the corresponding
1028 * readTypedList() to unmarshall them.
1029 *
1030 * @param val The list of objects to be written.
1031 *
1032 * @see #createTypedArrayList
1033 * @see #readTypedList
1034 * @see Parcelable
1035 */
1036 public final <T extends Parcelable> void writeTypedList(List<T> val) {
1037 if (val == null) {
1038 writeInt(-1);
1039 return;
1040 }
1041 int N = val.size();
1042 int i=0;
1043 writeInt(N);
1044 while (i < N) {
1045 T item = val.get(i);
1046 if (item != null) {
1047 writeInt(1);
1048 item.writeToParcel(this, 0);
1049 } else {
1050 writeInt(0);
1051 }
1052 i++;
1053 }
1054 }
1055
1056 /**
1057 * Flatten a List containing String objects into the parcel, at
1058 * the current dataPosition() and growing dataCapacity() if needed. They
1059 * can later be retrieved with {@link #createStringArrayList} or
1060 * {@link #readStringList}.
1061 *
1062 * @param val The list of strings to be written.
1063 *
1064 * @see #createStringArrayList
1065 * @see #readStringList
1066 */
1067 public final void writeStringList(List<String> val) {
1068 if (val == null) {
1069 writeInt(-1);
1070 return;
1071 }
1072 int N = val.size();
1073 int i=0;
1074 writeInt(N);
1075 while (i < N) {
1076 writeString(val.get(i));
1077 i++;
1078 }
1079 }
1080
1081 /**
1082 * Flatten a List containing IBinder objects into the parcel, at
1083 * the current dataPosition() and growing dataCapacity() if needed. They
1084 * can later be retrieved with {@link #createBinderArrayList} or
1085 * {@link #readBinderList}.
1086 *
1087 * @param val The list of strings to be written.
1088 *
1089 * @see #createBinderArrayList
1090 * @see #readBinderList
1091 */
1092 public final void writeBinderList(List<IBinder> val) {
1093 if (val == null) {
1094 writeInt(-1);
1095 return;
1096 }
1097 int N = val.size();
1098 int i=0;
1099 writeInt(N);
1100 while (i < N) {
1101 writeStrongBinder(val.get(i));
1102 i++;
1103 }
1104 }
1105
1106 /**
1107 * Flatten a heterogeneous array containing a particular object type into
1108 * the parcel, at
1109 * the current dataPosition() and growing dataCapacity() if needed. The
1110 * type of the objects in the array must be one that implements Parcelable.
1111 * Unlike the {@link #writeParcelableArray} method, however, only the
1112 * raw data of the objects is written and not their type, so you must use
1113 * {@link #readTypedArray} with the correct corresponding
1114 * {@link Parcelable.Creator} implementation to unmarshall them.
1115 *
1116 * @param val The array of objects to be written.
1117 * @param parcelableFlags Contextual flags as per
1118 * {@link Parcelable#writeToParcel(Parcel, int) Parcelable.writeToParcel()}.
1119 *
1120 * @see #readTypedArray
1121 * @see #writeParcelableArray
1122 * @see Parcelable.Creator
1123 */
1124 public final <T extends Parcelable> void writeTypedArray(T[] val,
1125 int parcelableFlags) {
1126 if (val != null) {
1127 int N = val.length;
1128 writeInt(N);
1129 for (int i=0; i<N; i++) {
1130 T item = val[i];
1131 if (item != null) {
1132 writeInt(1);
1133 item.writeToParcel(this, parcelableFlags);
1134 } else {
1135 writeInt(0);
1136 }
1137 }
1138 } else {
1139 writeInt(-1);
1140 }
1141 }
1142
1143 /**
1144 * Flatten a generic object in to a parcel. The given Object value may
1145 * currently be one of the following types:
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001146 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001147 * <ul>
1148 * <li> null
1149 * <li> String
1150 * <li> Byte
1151 * <li> Short
1152 * <li> Integer
1153 * <li> Long
1154 * <li> Float
1155 * <li> Double
1156 * <li> Boolean
1157 * <li> String[]
1158 * <li> boolean[]
1159 * <li> byte[]
1160 * <li> int[]
1161 * <li> long[]
1162 * <li> Object[] (supporting objects of the same type defined here).
1163 * <li> {@link Bundle}
1164 * <li> Map (as supported by {@link #writeMap}).
1165 * <li> Any object that implements the {@link Parcelable} protocol.
1166 * <li> Parcelable[]
1167 * <li> CharSequence (as supported by {@link TextUtils#writeToParcel}).
1168 * <li> List (as supported by {@link #writeList}).
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001169 * <li> {@link SparseArray} (as supported by {@link #writeSparseArray(SparseArray)}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001170 * <li> {@link IBinder}
1171 * <li> Any object that implements Serializable (but see
1172 * {@link #writeSerializable} for caveats). Note that all of the
1173 * previous types have relatively efficient implementations for
1174 * writing to a Parcel; having to rely on the generic serialization
1175 * approach is much less efficient and should be avoided whenever
1176 * possible.
1177 * </ul>
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001178 *
1179 * <p class="caution">{@link Parcelable} objects are written with
1180 * {@link Parcelable#writeToParcel} using contextual flags of 0. When
1181 * serializing objects containing {@link ParcelFileDescriptor}s,
1182 * this may result in file descriptor leaks when they are returned from
1183 * Binder calls (where {@link Parcelable#PARCELABLE_WRITE_RETURN_VALUE}
1184 * should be used).</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001185 */
1186 public final void writeValue(Object v) {
1187 if (v == null) {
1188 writeInt(VAL_NULL);
1189 } else if (v instanceof String) {
1190 writeInt(VAL_STRING);
1191 writeString((String) v);
1192 } else if (v instanceof Integer) {
1193 writeInt(VAL_INTEGER);
1194 writeInt((Integer) v);
1195 } else if (v instanceof Map) {
1196 writeInt(VAL_MAP);
1197 writeMap((Map) v);
1198 } else if (v instanceof Bundle) {
1199 // Must be before Parcelable
1200 writeInt(VAL_BUNDLE);
1201 writeBundle((Bundle) v);
1202 } else if (v instanceof Parcelable) {
1203 writeInt(VAL_PARCELABLE);
1204 writeParcelable((Parcelable) v, 0);
1205 } else if (v instanceof Short) {
1206 writeInt(VAL_SHORT);
1207 writeInt(((Short) v).intValue());
1208 } else if (v instanceof Long) {
1209 writeInt(VAL_LONG);
1210 writeLong((Long) v);
1211 } else if (v instanceof Float) {
1212 writeInt(VAL_FLOAT);
1213 writeFloat((Float) v);
1214 } else if (v instanceof Double) {
1215 writeInt(VAL_DOUBLE);
1216 writeDouble((Double) v);
1217 } else if (v instanceof Boolean) {
1218 writeInt(VAL_BOOLEAN);
1219 writeInt((Boolean) v ? 1 : 0);
1220 } else if (v instanceof CharSequence) {
1221 // Must be after String
1222 writeInt(VAL_CHARSEQUENCE);
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001223 writeCharSequence((CharSequence) v);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001224 } else if (v instanceof List) {
1225 writeInt(VAL_LIST);
1226 writeList((List) v);
1227 } else if (v instanceof SparseArray) {
1228 writeInt(VAL_SPARSEARRAY);
1229 writeSparseArray((SparseArray) v);
1230 } else if (v instanceof boolean[]) {
1231 writeInt(VAL_BOOLEANARRAY);
1232 writeBooleanArray((boolean[]) v);
1233 } else if (v instanceof byte[]) {
1234 writeInt(VAL_BYTEARRAY);
1235 writeByteArray((byte[]) v);
1236 } else if (v instanceof String[]) {
1237 writeInt(VAL_STRINGARRAY);
1238 writeStringArray((String[]) v);
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001239 } else if (v instanceof CharSequence[]) {
1240 // Must be after String[] and before Object[]
1241 writeInt(VAL_CHARSEQUENCEARRAY);
1242 writeCharSequenceArray((CharSequence[]) v);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001243 } else if (v instanceof IBinder) {
1244 writeInt(VAL_IBINDER);
1245 writeStrongBinder((IBinder) v);
1246 } else if (v instanceof Parcelable[]) {
1247 writeInt(VAL_PARCELABLEARRAY);
1248 writeParcelableArray((Parcelable[]) v, 0);
1249 } else if (v instanceof Object[]) {
1250 writeInt(VAL_OBJECTARRAY);
1251 writeArray((Object[]) v);
1252 } else if (v instanceof int[]) {
1253 writeInt(VAL_INTARRAY);
1254 writeIntArray((int[]) v);
1255 } else if (v instanceof long[]) {
1256 writeInt(VAL_LONGARRAY);
1257 writeLongArray((long[]) v);
1258 } else if (v instanceof Byte) {
1259 writeInt(VAL_BYTE);
1260 writeInt((Byte) v);
1261 } else if (v instanceof Serializable) {
1262 // Must be last
1263 writeInt(VAL_SERIALIZABLE);
1264 writeSerializable((Serializable) v);
1265 } else {
1266 throw new RuntimeException("Parcel: unable to marshal value " + v);
1267 }
1268 }
1269
1270 /**
1271 * Flatten the name of the class of the Parcelable and its contents
1272 * into the parcel.
Dan Egnorb3e4ef32010-07-20 09:03:35 -07001273 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001274 * @param p The Parcelable object to be written.
1275 * @param parcelableFlags Contextual flags as per
1276 * {@link Parcelable#writeToParcel(Parcel, int) Parcelable.writeToParcel()}.
1277 */
1278 public final void writeParcelable(Parcelable p, int parcelableFlags) {
1279 if (p == null) {
1280 writeString(null);
1281 return;
1282 }
1283 String name = p.getClass().getName();
1284 writeString(name);
1285 p.writeToParcel(this, parcelableFlags);
1286 }
1287
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -08001288 /** @hide */
1289 public final void writeParcelableCreator(Parcelable p) {
1290 String name = p.getClass().getName();
1291 writeString(name);
1292 }
1293
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001294 /**
1295 * Write a generic serializable object in to a Parcel. It is strongly
1296 * recommended that this method be avoided, since the serialization
1297 * overhead is extremely large, and this approach will be much slower than
1298 * using the other approaches to writing data in to a Parcel.
1299 */
1300 public final void writeSerializable(Serializable s) {
1301 if (s == null) {
1302 writeString(null);
1303 return;
1304 }
1305 String name = s.getClass().getName();
1306 writeString(name);
1307
1308 ByteArrayOutputStream baos = new ByteArrayOutputStream();
1309 try {
1310 ObjectOutputStream oos = new ObjectOutputStream(baos);
1311 oos.writeObject(s);
1312 oos.close();
1313
1314 writeByteArray(baos.toByteArray());
1315 } catch (IOException ioe) {
1316 throw new RuntimeException("Parcelable encountered " +
1317 "IOException writing serializable object (name = " + name +
1318 ")", ioe);
1319 }
1320 }
1321
1322 /**
1323 * Special function for writing an exception result at the header of
1324 * a parcel, to be used when returning an exception from a transaction.
1325 * Note that this currently only supports a few exception types; any other
1326 * exception will be re-thrown by this function as a RuntimeException
1327 * (to be caught by the system's last-resort exception handling when
1328 * dispatching a transaction).
1329 *
1330 * <p>The supported exception types are:
1331 * <ul>
1332 * <li>{@link BadParcelableException}
1333 * <li>{@link IllegalArgumentException}
1334 * <li>{@link IllegalStateException}
1335 * <li>{@link NullPointerException}
1336 * <li>{@link SecurityException}
Dianne Hackborn7e714422013-09-13 17:32:57 -07001337 * <li>{@link NetworkOnMainThreadException}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001338 * </ul>
1339 *
1340 * @param e The Exception to be written.
1341 *
1342 * @see #writeNoException
1343 * @see #readException
1344 */
1345 public final void writeException(Exception e) {
1346 int code = 0;
1347 if (e instanceof SecurityException) {
1348 code = EX_SECURITY;
1349 } else if (e instanceof BadParcelableException) {
1350 code = EX_BAD_PARCELABLE;
1351 } else if (e instanceof IllegalArgumentException) {
1352 code = EX_ILLEGAL_ARGUMENT;
1353 } else if (e instanceof NullPointerException) {
1354 code = EX_NULL_POINTER;
1355 } else if (e instanceof IllegalStateException) {
1356 code = EX_ILLEGAL_STATE;
Dianne Hackborn7e714422013-09-13 17:32:57 -07001357 } else if (e instanceof NetworkOnMainThreadException) {
1358 code = EX_NETWORK_MAIN_THREAD;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001359 }
1360 writeInt(code);
Brad Fitzpatrick703e5d32010-07-15 13:16:41 -07001361 StrictMode.clearGatheredViolations();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001362 if (code == 0) {
1363 if (e instanceof RuntimeException) {
1364 throw (RuntimeException) e;
1365 }
1366 throw new RuntimeException(e);
1367 }
1368 writeString(e.getMessage());
1369 }
1370
1371 /**
1372 * Special function for writing information at the front of the Parcel
1373 * indicating that no exception occurred.
1374 *
1375 * @see #writeException
1376 * @see #readException
1377 */
1378 public final void writeNoException() {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07001379 // Despite the name of this function ("write no exception"),
1380 // it should instead be thought of as "write the RPC response
1381 // header", but because this function name is written out by
1382 // the AIDL compiler, we're not going to rename it.
1383 //
1384 // The response header, in the non-exception case (see also
1385 // writeException above, also called by the AIDL compiler), is
1386 // either a 0 (the default case), or EX_HAS_REPLY_HEADER if
1387 // StrictMode has gathered up violations that have occurred
1388 // during a Binder call, in which case we write out the number
1389 // of violations and their details, serialized, before the
1390 // actual RPC respons data. The receiving end of this is
1391 // readException(), below.
1392 if (StrictMode.hasGatheredViolations()) {
1393 writeInt(EX_HAS_REPLY_HEADER);
1394 final int sizePosition = dataPosition();
1395 writeInt(0); // total size of fat header, to be filled in later
1396 StrictMode.writeGatheredViolationsToParcel(this);
1397 final int payloadPosition = dataPosition();
1398 setDataPosition(sizePosition);
1399 writeInt(payloadPosition - sizePosition); // header size
1400 setDataPosition(payloadPosition);
1401 } else {
1402 writeInt(0);
1403 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001404 }
1405
1406 /**
1407 * Special function for reading an exception result from the header of
1408 * a parcel, to be used after receiving the result of a transaction. This
1409 * will throw the exception for you if it had been written to the Parcel,
1410 * otherwise return and let you read the normal result data from the Parcel.
1411 *
1412 * @see #writeException
1413 * @see #writeNoException
1414 */
1415 public final void readException() {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07001416 int code = readExceptionCode();
1417 if (code != 0) {
1418 String msg = readString();
1419 readException(code, msg);
1420 }
1421 }
1422
1423 /**
1424 * Parses the header of a Binder call's response Parcel and
1425 * returns the exception code. Deals with lite or fat headers.
1426 * In the common successful case, this header is generally zero.
1427 * In less common cases, it's a small negative number and will be
1428 * followed by an error string.
1429 *
1430 * This exists purely for android.database.DatabaseUtils and
1431 * insulating it from having to handle fat headers as returned by
1432 * e.g. StrictMode-induced RPC responses.
1433 *
1434 * @hide
1435 */
1436 public final int readExceptionCode() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001437 int code = readInt();
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07001438 if (code == EX_HAS_REPLY_HEADER) {
1439 int headerSize = readInt();
1440 if (headerSize == 0) {
1441 Log.e(TAG, "Unexpected zero-sized Parcel reply header.");
1442 } else {
1443 // Currently the only thing in the header is StrictMode stacks,
1444 // but discussions around event/RPC tracing suggest we might
1445 // put that here too. If so, switch on sub-header tags here.
1446 // But for now, just parse out the StrictMode stuff.
1447 StrictMode.readAndHandleBinderCallViolations(this);
1448 }
1449 // And fat response headers are currently only used when
1450 // there are no exceptions, so return no error:
1451 return 0;
1452 }
1453 return code;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001454 }
1455
1456 /**
Mark Doliner879ea452014-01-02 12:38:07 -08001457 * Throw an exception with the given message. Not intended for use
1458 * outside the Parcel class.
1459 *
1460 * @param code Used to determine which exception class to throw.
1461 * @param msg The exception message.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001462 */
1463 public final void readException(int code, String msg) {
1464 switch (code) {
1465 case EX_SECURITY:
1466 throw new SecurityException(msg);
1467 case EX_BAD_PARCELABLE:
1468 throw new BadParcelableException(msg);
1469 case EX_ILLEGAL_ARGUMENT:
1470 throw new IllegalArgumentException(msg);
1471 case EX_NULL_POINTER:
1472 throw new NullPointerException(msg);
1473 case EX_ILLEGAL_STATE:
1474 throw new IllegalStateException(msg);
Dianne Hackborn7e714422013-09-13 17:32:57 -07001475 case EX_NETWORK_MAIN_THREAD:
1476 throw new NetworkOnMainThreadException();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001477 }
1478 throw new RuntimeException("Unknown exception code: " + code
1479 + " msg " + msg);
1480 }
1481
1482 /**
1483 * Read an integer value from the parcel at the current dataPosition().
1484 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001485 public final int readInt() {
1486 return nativeReadInt(mNativePtr);
1487 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001488
1489 /**
1490 * Read a long integer value from the parcel at the current dataPosition().
1491 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001492 public final long readLong() {
1493 return nativeReadLong(mNativePtr);
1494 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001495
1496 /**
1497 * Read a floating point value from the parcel at the current
1498 * dataPosition().
1499 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001500 public final float readFloat() {
1501 return nativeReadFloat(mNativePtr);
1502 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001503
1504 /**
1505 * Read a double precision floating point value from the parcel at the
1506 * current dataPosition().
1507 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001508 public final double readDouble() {
1509 return nativeReadDouble(mNativePtr);
1510 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001511
1512 /**
1513 * Read a string value from the parcel at the current dataPosition().
1514 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001515 public final String readString() {
1516 return nativeReadString(mNativePtr);
1517 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001518
1519 /**
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001520 * Read a CharSequence value from the parcel at the current dataPosition().
1521 * @hide
1522 */
1523 public final CharSequence readCharSequence() {
1524 return TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(this);
1525 }
1526
1527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001528 * Read an object from the parcel at the current dataPosition().
1529 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001530 public final IBinder readStrongBinder() {
1531 return nativeReadStrongBinder(mNativePtr);
1532 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001533
1534 /**
1535 * Read a FileDescriptor from the parcel at the current dataPosition().
1536 */
1537 public final ParcelFileDescriptor readFileDescriptor() {
Jeff Sharkey047238c2012-03-07 16:51:38 -08001538 FileDescriptor fd = nativeReadFileDescriptor(mNativePtr);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001539 return fd != null ? new ParcelFileDescriptor(fd) : null;
1540 }
1541
Jeff Sharkeyda5a3e12013-08-11 12:54:42 -07001542 /** {@hide} */
1543 public final FileDescriptor readRawFileDescriptor() {
1544 return nativeReadFileDescriptor(mNativePtr);
1545 }
1546
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001547 /*package*/ static native FileDescriptor openFileDescriptor(String file,
1548 int mode) throws FileNotFoundException;
Dianne Hackborn9a849832011-04-07 15:11:57 -07001549 /*package*/ static native FileDescriptor dupFileDescriptor(FileDescriptor orig)
1550 throws IOException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 /*package*/ static native void closeFileDescriptor(FileDescriptor desc)
1552 throws IOException;
Dianne Hackbornc9119f52011-02-28 18:03:26 -08001553 /*package*/ static native void clearFileDescriptor(FileDescriptor desc);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001554
1555 /**
1556 * Read a byte value from the parcel at the current dataPosition().
1557 */
1558 public final byte readByte() {
1559 return (byte)(readInt() & 0xff);
1560 }
1561
1562 /**
1563 * Please use {@link #readBundle(ClassLoader)} instead (whose data must have
1564 * been written with {@link #writeBundle}. Read into an existing Map object
1565 * from the parcel at the current dataPosition().
1566 */
1567 public final void readMap(Map outVal, ClassLoader loader) {
1568 int N = readInt();
1569 readMapInternal(outVal, N, loader);
1570 }
1571
1572 /**
1573 * Read into an existing List object from the parcel at the current
1574 * dataPosition(), using the given class loader to load any enclosed
1575 * Parcelables. If it is null, the default class loader is used.
1576 */
1577 public final void readList(List outVal, ClassLoader loader) {
1578 int N = readInt();
1579 readListInternal(outVal, N, loader);
1580 }
1581
1582 /**
1583 * Please use {@link #readBundle(ClassLoader)} instead (whose data must have
1584 * been written with {@link #writeBundle}. Read and return a new HashMap
1585 * object from the parcel at the current dataPosition(), using the given
1586 * class loader to load any enclosed Parcelables. Returns null if
1587 * the previously written map object was null.
1588 */
1589 public final HashMap readHashMap(ClassLoader loader)
1590 {
1591 int N = readInt();
1592 if (N < 0) {
1593 return null;
1594 }
1595 HashMap m = new HashMap(N);
1596 readMapInternal(m, N, loader);
1597 return m;
1598 }
1599
1600 /**
1601 * Read and return a new Bundle object from the parcel at the current
1602 * dataPosition(). Returns null if the previously written Bundle object was
1603 * null.
1604 */
1605 public final Bundle readBundle() {
1606 return readBundle(null);
1607 }
1608
1609 /**
1610 * Read and return a new Bundle object from the parcel at the current
1611 * dataPosition(), using the given class loader to initialize the class
1612 * loader of the Bundle for later retrieval of Parcelable objects.
1613 * Returns null if the previously written Bundle object was null.
1614 */
1615 public final Bundle readBundle(ClassLoader loader) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001616 int length = readInt();
1617 if (length < 0) {
Dianne Hackborn4a7d8242013-10-03 10:19:20 -07001618 if (Bundle.DEBUG) Log.d(TAG, "null bundle: length=" + length);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001619 return null;
1620 }
Dianne Hackborn6aff9052009-05-22 13:20:23 -07001621
1622 final Bundle bundle = new Bundle(this, length);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001623 if (loader != null) {
1624 bundle.setClassLoader(loader);
1625 }
1626 return bundle;
1627 }
1628
1629 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001630 * Read and return a byte[] object from the parcel.
1631 */
Jeff Sharkey047238c2012-03-07 16:51:38 -08001632 public final byte[] createByteArray() {
1633 return nativeCreateByteArray(mNativePtr);
1634 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001635
1636 /**
1637 * Read a byte[] object from the parcel and copy it into the
1638 * given byte array.
1639 */
1640 public final void readByteArray(byte[] val) {
1641 // TODO: make this a native method to avoid the extra copy.
1642 byte[] ba = createByteArray();
1643 if (ba.length == val.length) {
1644 System.arraycopy(ba, 0, val, 0, ba.length);
1645 } else {
1646 throw new RuntimeException("bad array lengths");
1647 }
1648 }
1649
1650 /**
1651 * Read and return a String[] object from the parcel.
1652 * {@hide}
1653 */
1654 public final String[] readStringArray() {
1655 String[] array = null;
1656
1657 int length = readInt();
1658 if (length >= 0)
1659 {
1660 array = new String[length];
1661
1662 for (int i = 0 ; i < length ; i++)
1663 {
1664 array[i] = readString();
1665 }
1666 }
1667
1668 return array;
1669 }
1670
1671 /**
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00001672 * Read and return a CharSequence[] object from the parcel.
1673 * {@hide}
1674 */
1675 public final CharSequence[] readCharSequenceArray() {
1676 CharSequence[] array = null;
1677
1678 int length = readInt();
1679 if (length >= 0)
1680 {
1681 array = new CharSequence[length];
1682
1683 for (int i = 0 ; i < length ; i++)
1684 {
1685 array[i] = readCharSequence();
1686 }
1687 }
1688
1689 return array;
1690 }
1691
1692 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001693 * Read and return a new ArrayList object from the parcel at the current
1694 * dataPosition(). Returns null if the previously written list object was
1695 * null. The given class loader will be used to load any enclosed
1696 * Parcelables.
1697 */
1698 public final ArrayList readArrayList(ClassLoader loader) {
1699 int N = readInt();
1700 if (N < 0) {
1701 return null;
1702 }
1703 ArrayList l = new ArrayList(N);
1704 readListInternal(l, N, loader);
1705 return l;
1706 }
1707
1708 /**
1709 * Read and return a new Object array from the parcel at the current
1710 * dataPosition(). Returns null if the previously written array was
1711 * null. The given class loader will be used to load any enclosed
1712 * Parcelables.
1713 */
1714 public final Object[] readArray(ClassLoader loader) {
1715 int N = readInt();
1716 if (N < 0) {
1717 return null;
1718 }
1719 Object[] l = new Object[N];
1720 readArrayInternal(l, N, loader);
1721 return l;
1722 }
1723
1724 /**
1725 * Read and return a new SparseArray object from the parcel at the current
1726 * dataPosition(). Returns null if the previously written list object was
1727 * null. The given class loader will be used to load any enclosed
1728 * Parcelables.
1729 */
1730 public final SparseArray readSparseArray(ClassLoader loader) {
1731 int N = readInt();
1732 if (N < 0) {
1733 return null;
1734 }
1735 SparseArray sa = new SparseArray(N);
1736 readSparseArrayInternal(sa, N, loader);
1737 return sa;
1738 }
1739
1740 /**
1741 * Read and return a new SparseBooleanArray object from the parcel at the current
1742 * dataPosition(). Returns null if the previously written list object was
1743 * null.
1744 */
1745 public final SparseBooleanArray readSparseBooleanArray() {
1746 int N = readInt();
1747 if (N < 0) {
1748 return null;
1749 }
1750 SparseBooleanArray sa = new SparseBooleanArray(N);
1751 readSparseBooleanArrayInternal(sa, N);
1752 return sa;
1753 }
1754
1755 /**
1756 * Read and return a new ArrayList containing a particular object type from
1757 * the parcel that was written with {@link #writeTypedList} at the
1758 * current dataPosition(). Returns null if the
1759 * previously written list object was null. The list <em>must</em> have
1760 * previously been written via {@link #writeTypedList} with the same object
1761 * type.
1762 *
1763 * @return A newly created ArrayList containing objects with the same data
1764 * as those that were previously written.
1765 *
1766 * @see #writeTypedList
1767 */
1768 public final <T> ArrayList<T> createTypedArrayList(Parcelable.Creator<T> c) {
1769 int N = readInt();
1770 if (N < 0) {
1771 return null;
1772 }
1773 ArrayList<T> l = new ArrayList<T>(N);
1774 while (N > 0) {
1775 if (readInt() != 0) {
1776 l.add(c.createFromParcel(this));
1777 } else {
1778 l.add(null);
1779 }
1780 N--;
1781 }
1782 return l;
1783 }
1784
1785 /**
1786 * Read into the given List items containing a particular object type
1787 * that were written with {@link #writeTypedList} at the
1788 * current dataPosition(). The list <em>must</em> have
1789 * previously been written via {@link #writeTypedList} with the same object
1790 * type.
1791 *
1792 * @return A newly created ArrayList containing objects with the same data
1793 * as those that were previously written.
1794 *
1795 * @see #writeTypedList
1796 */
1797 public final <T> void readTypedList(List<T> list, Parcelable.Creator<T> c) {
1798 int M = list.size();
1799 int N = readInt();
1800 int i = 0;
1801 for (; i < M && i < N; i++) {
1802 if (readInt() != 0) {
1803 list.set(i, c.createFromParcel(this));
1804 } else {
1805 list.set(i, null);
1806 }
1807 }
1808 for (; i<N; i++) {
1809 if (readInt() != 0) {
1810 list.add(c.createFromParcel(this));
1811 } else {
1812 list.add(null);
1813 }
1814 }
1815 for (; i<M; i++) {
1816 list.remove(N);
1817 }
1818 }
1819
1820 /**
1821 * Read and return a new ArrayList containing String objects from
1822 * the parcel that was written with {@link #writeStringList} at the
1823 * current dataPosition(). Returns null if the
1824 * previously written list object was null.
1825 *
1826 * @return A newly created ArrayList containing strings with the same data
1827 * as those that were previously written.
1828 *
1829 * @see #writeStringList
1830 */
1831 public final ArrayList<String> createStringArrayList() {
1832 int N = readInt();
1833 if (N < 0) {
1834 return null;
1835 }
1836 ArrayList<String> l = new ArrayList<String>(N);
1837 while (N > 0) {
1838 l.add(readString());
1839 N--;
1840 }
1841 return l;
1842 }
1843
1844 /**
1845 * Read and return a new ArrayList containing IBinder objects from
1846 * the parcel that was written with {@link #writeBinderList} at the
1847 * current dataPosition(). Returns null if the
1848 * previously written list object was null.
1849 *
1850 * @return A newly created ArrayList containing strings with the same data
1851 * as those that were previously written.
1852 *
1853 * @see #writeBinderList
1854 */
1855 public final ArrayList<IBinder> createBinderArrayList() {
1856 int N = readInt();
1857 if (N < 0) {
1858 return null;
1859 }
1860 ArrayList<IBinder> l = new ArrayList<IBinder>(N);
1861 while (N > 0) {
1862 l.add(readStrongBinder());
1863 N--;
1864 }
1865 return l;
1866 }
1867
1868 /**
1869 * Read into the given List items String objects that were written with
1870 * {@link #writeStringList} at the current dataPosition().
1871 *
1872 * @return A newly created ArrayList containing strings with the same data
1873 * as those that were previously written.
1874 *
1875 * @see #writeStringList
1876 */
1877 public final void readStringList(List<String> list) {
1878 int M = list.size();
1879 int N = readInt();
1880 int i = 0;
1881 for (; i < M && i < N; i++) {
1882 list.set(i, readString());
1883 }
1884 for (; i<N; i++) {
1885 list.add(readString());
1886 }
1887 for (; i<M; i++) {
1888 list.remove(N);
1889 }
1890 }
1891
1892 /**
1893 * Read into the given List items IBinder objects that were written with
1894 * {@link #writeBinderList} at the current dataPosition().
1895 *
1896 * @return A newly created ArrayList containing strings with the same data
1897 * as those that were previously written.
1898 *
1899 * @see #writeBinderList
1900 */
1901 public final void readBinderList(List<IBinder> list) {
1902 int M = list.size();
1903 int N = readInt();
1904 int i = 0;
1905 for (; i < M && i < N; i++) {
1906 list.set(i, readStrongBinder());
1907 }
1908 for (; i<N; i++) {
1909 list.add(readStrongBinder());
1910 }
1911 for (; i<M; i++) {
1912 list.remove(N);
1913 }
1914 }
1915
1916 /**
1917 * Read and return a new array containing a particular object type from
1918 * the parcel at the current dataPosition(). Returns null if the
1919 * previously written array was null. The array <em>must</em> have
1920 * previously been written via {@link #writeTypedArray} with the same
1921 * object type.
1922 *
1923 * @return A newly created array containing objects with the same data
1924 * as those that were previously written.
1925 *
1926 * @see #writeTypedArray
1927 */
1928 public final <T> T[] createTypedArray(Parcelable.Creator<T> c) {
1929 int N = readInt();
1930 if (N < 0) {
1931 return null;
1932 }
1933 T[] l = c.newArray(N);
1934 for (int i=0; i<N; i++) {
1935 if (readInt() != 0) {
1936 l[i] = c.createFromParcel(this);
1937 }
1938 }
1939 return l;
1940 }
1941
1942 public final <T> void readTypedArray(T[] val, Parcelable.Creator<T> c) {
1943 int N = readInt();
1944 if (N == val.length) {
1945 for (int i=0; i<N; i++) {
1946 if (readInt() != 0) {
1947 val[i] = c.createFromParcel(this);
1948 } else {
1949 val[i] = null;
1950 }
1951 }
1952 } else {
1953 throw new RuntimeException("bad array lengths");
1954 }
1955 }
1956
1957 /**
1958 * @deprecated
1959 * @hide
1960 */
1961 @Deprecated
1962 public final <T> T[] readTypedArray(Parcelable.Creator<T> c) {
1963 return createTypedArray(c);
1964 }
1965
1966 /**
1967 * Write a heterogeneous array of Parcelable objects into the Parcel.
1968 * Each object in the array is written along with its class name, so
1969 * that the correct class can later be instantiated. As a result, this
1970 * has significantly more overhead than {@link #writeTypedArray}, but will
1971 * correctly handle an array containing more than one type of object.
1972 *
1973 * @param value The array of objects to be written.
1974 * @param parcelableFlags Contextual flags as per
1975 * {@link Parcelable#writeToParcel(Parcel, int) Parcelable.writeToParcel()}.
1976 *
1977 * @see #writeTypedArray
1978 */
1979 public final <T extends Parcelable> void writeParcelableArray(T[] value,
1980 int parcelableFlags) {
1981 if (value != null) {
1982 int N = value.length;
1983 writeInt(N);
1984 for (int i=0; i<N; i++) {
1985 writeParcelable(value[i], parcelableFlags);
1986 }
1987 } else {
1988 writeInt(-1);
1989 }
1990 }
1991
1992 /**
1993 * Read a typed object from a parcel. The given class loader will be
1994 * used to load any enclosed Parcelables. If it is null, the default class
1995 * loader will be used.
1996 */
1997 public final Object readValue(ClassLoader loader) {
1998 int type = readInt();
1999
2000 switch (type) {
2001 case VAL_NULL:
2002 return null;
2003
2004 case VAL_STRING:
2005 return readString();
2006
2007 case VAL_INTEGER:
2008 return readInt();
2009
2010 case VAL_MAP:
2011 return readHashMap(loader);
2012
2013 case VAL_PARCELABLE:
2014 return readParcelable(loader);
2015
2016 case VAL_SHORT:
2017 return (short) readInt();
2018
2019 case VAL_LONG:
2020 return readLong();
2021
2022 case VAL_FLOAT:
2023 return readFloat();
2024
2025 case VAL_DOUBLE:
2026 return readDouble();
2027
2028 case VAL_BOOLEAN:
2029 return readInt() == 1;
2030
2031 case VAL_CHARSEQUENCE:
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00002032 return readCharSequence();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002033
2034 case VAL_LIST:
2035 return readArrayList(loader);
2036
2037 case VAL_BOOLEANARRAY:
2038 return createBooleanArray();
2039
2040 case VAL_BYTEARRAY:
2041 return createByteArray();
2042
2043 case VAL_STRINGARRAY:
2044 return readStringArray();
2045
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00002046 case VAL_CHARSEQUENCEARRAY:
2047 return readCharSequenceArray();
2048
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002049 case VAL_IBINDER:
2050 return readStrongBinder();
2051
2052 case VAL_OBJECTARRAY:
2053 return readArray(loader);
2054
2055 case VAL_INTARRAY:
2056 return createIntArray();
2057
2058 case VAL_LONGARRAY:
2059 return createLongArray();
2060
2061 case VAL_BYTE:
2062 return readByte();
2063
2064 case VAL_SERIALIZABLE:
2065 return readSerializable();
2066
2067 case VAL_PARCELABLEARRAY:
2068 return readParcelableArray(loader);
2069
2070 case VAL_SPARSEARRAY:
2071 return readSparseArray(loader);
2072
2073 case VAL_SPARSEBOOLEANARRAY:
2074 return readSparseBooleanArray();
2075
2076 case VAL_BUNDLE:
2077 return readBundle(loader); // loading will be deferred
2078
2079 default:
2080 int off = dataPosition() - 4;
2081 throw new RuntimeException(
2082 "Parcel " + this + ": Unmarshalling unknown type code " + type + " at offset " + off);
2083 }
2084 }
2085
2086 /**
2087 * Read and return a new Parcelable from the parcel. The given class loader
2088 * will be used to load any enclosed Parcelables. If it is null, the default
2089 * class loader will be used.
2090 * @param loader A ClassLoader from which to instantiate the Parcelable
2091 * object, or null for the default class loader.
2092 * @return Returns the newly created Parcelable, or null if a null
2093 * object has been written.
2094 * @throws BadParcelableException Throws BadParcelableException if there
2095 * was an error trying to instantiate the Parcelable.
2096 */
2097 public final <T extends Parcelable> T readParcelable(ClassLoader loader) {
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -08002098 Parcelable.Creator<T> creator = readParcelableCreator(loader);
2099 if (creator == null) {
2100 return null;
2101 }
2102 if (creator instanceof Parcelable.ClassLoaderCreator<?>) {
2103 return ((Parcelable.ClassLoaderCreator<T>)creator).createFromParcel(this, loader);
2104 }
2105 return creator.createFromParcel(this);
2106 }
2107
2108 /** @hide */
2109 public final <T extends Parcelable> T readCreator(Parcelable.Creator<T> creator,
2110 ClassLoader loader) {
2111 if (creator instanceof Parcelable.ClassLoaderCreator<?>) {
2112 return ((Parcelable.ClassLoaderCreator<T>)creator).createFromParcel(this, loader);
2113 }
2114 return creator.createFromParcel(this);
2115 }
2116
2117 /** @hide */
2118 public final <T extends Parcelable> Parcelable.Creator<T> readParcelableCreator(
2119 ClassLoader loader) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002120 String name = readString();
2121 if (name == null) {
2122 return null;
2123 }
2124 Parcelable.Creator<T> creator;
2125 synchronized (mCreators) {
2126 HashMap<String,Parcelable.Creator> map = mCreators.get(loader);
2127 if (map == null) {
2128 map = new HashMap<String,Parcelable.Creator>();
2129 mCreators.put(loader, map);
2130 }
2131 creator = map.get(name);
2132 if (creator == null) {
2133 try {
2134 Class c = loader == null ?
2135 Class.forName(name) : Class.forName(name, true, loader);
2136 Field f = c.getField("CREATOR");
2137 creator = (Parcelable.Creator)f.get(null);
2138 }
2139 catch (IllegalAccessException e) {
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002140 Log.e(TAG, "Illegal access when unmarshalling: "
2141 + name, e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002142 throw new BadParcelableException(
2143 "IllegalAccessException when unmarshalling: " + name);
2144 }
2145 catch (ClassNotFoundException e) {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002146 Log.e(TAG, "Class not found when unmarshalling: "
Daniel Sandlerdcbaf662013-04-26 16:23:09 -04002147 + name, e);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 throw new BadParcelableException(
2149 "ClassNotFoundException when unmarshalling: " + name);
2150 }
2151 catch (ClassCastException e) {
2152 throw new BadParcelableException("Parcelable protocol requires a "
2153 + "Parcelable.Creator object called "
2154 + " CREATOR on class " + name);
2155 }
2156 catch (NoSuchFieldException e) {
2157 throw new BadParcelableException("Parcelable protocol requires a "
2158 + "Parcelable.Creator object called "
2159 + " CREATOR on class " + name);
2160 }
Irfan Sheriff97a72f62013-01-11 10:45:51 -08002161 catch (NullPointerException e) {
2162 throw new BadParcelableException("Parcelable protocol requires "
2163 + "the CREATOR object to be static on class " + name);
2164 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002165 if (creator == null) {
2166 throw new BadParcelableException("Parcelable protocol requires a "
2167 + "Parcelable.Creator object called "
2168 + " CREATOR on class " + name);
2169 }
2170
2171 map.put(name, creator);
2172 }
2173 }
2174
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -08002175 return creator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002176 }
2177
2178 /**
2179 * Read and return a new Parcelable array from the parcel.
2180 * The given class loader will be used to load any enclosed
2181 * Parcelables.
2182 * @return the Parcelable array, or null if the array is null
2183 */
2184 public final Parcelable[] readParcelableArray(ClassLoader loader) {
2185 int N = readInt();
2186 if (N < 0) {
2187 return null;
2188 }
2189 Parcelable[] p = new Parcelable[N];
2190 for (int i = 0; i < N; i++) {
2191 p[i] = (Parcelable) readParcelable(loader);
2192 }
2193 return p;
2194 }
2195
2196 /**
2197 * Read and return a new Serializable object from the parcel.
2198 * @return the Serializable object, or null if the Serializable name
2199 * wasn't found in the parcel.
2200 */
2201 public final Serializable readSerializable() {
2202 String name = readString();
2203 if (name == null) {
2204 // For some reason we were unable to read the name of the Serializable (either there
2205 // is nothing left in the Parcel to read, or the next value wasn't a String), so
2206 // return null, which indicates that the name wasn't found in the parcel.
2207 return null;
2208 }
2209
2210 byte[] serializedData = createByteArray();
2211 ByteArrayInputStream bais = new ByteArrayInputStream(serializedData);
2212 try {
2213 ObjectInputStream ois = new ObjectInputStream(bais);
2214 return (Serializable) ois.readObject();
2215 } catch (IOException ioe) {
2216 throw new RuntimeException("Parcelable encountered " +
2217 "IOException reading a Serializable object (name = " + name +
2218 ")", ioe);
2219 } catch (ClassNotFoundException cnfe) {
2220 throw new RuntimeException("Parcelable encountered" +
2221 "ClassNotFoundException reading a Serializable object (name = "
2222 + name + ")", cnfe);
2223 }
2224 }
2225
2226 // Cache of previously looked up CREATOR.createFromParcel() methods for
2227 // particular classes. Keys are the names of the classes, values are
2228 // Method objects.
2229 private static final HashMap<ClassLoader,HashMap<String,Parcelable.Creator>>
2230 mCreators = new HashMap<ClassLoader,HashMap<String,Parcelable.Creator>>();
2231
2232 static protected final Parcel obtain(int obj) {
2233 final Parcel[] pool = sHolderPool;
2234 synchronized (pool) {
2235 Parcel p;
2236 for (int i=0; i<POOL_SIZE; i++) {
2237 p = pool[i];
2238 if (p != null) {
2239 pool[i] = null;
2240 if (DEBUG_RECYCLE) {
2241 p.mStack = new RuntimeException();
2242 }
2243 p.init(obj);
2244 return p;
2245 }
2246 }
2247 }
2248 return new Parcel(obj);
2249 }
2250
Jeff Sharkey047238c2012-03-07 16:51:38 -08002251 private Parcel(int nativePtr) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002252 if (DEBUG_RECYCLE) {
2253 mStack = new RuntimeException();
2254 }
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002255 //Log.i(TAG, "Initializing obj=0x" + Integer.toHexString(obj), mStack);
Jeff Sharkey047238c2012-03-07 16:51:38 -08002256 init(nativePtr);
2257 }
2258
2259 private void init(int nativePtr) {
2260 if (nativePtr != 0) {
2261 mNativePtr = nativePtr;
2262 mOwnsNativeParcelObject = false;
2263 } else {
2264 mNativePtr = nativeCreate();
2265 mOwnsNativeParcelObject = true;
2266 }
2267 }
2268
2269 private void freeBuffer() {
2270 if (mOwnsNativeParcelObject) {
2271 nativeFreeBuffer(mNativePtr);
2272 }
2273 }
2274
2275 private void destroy() {
2276 if (mNativePtr != 0) {
2277 if (mOwnsNativeParcelObject) {
2278 nativeDestroy(mNativePtr);
2279 }
2280 mNativePtr = 0;
2281 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002282 }
2283
2284 @Override
2285 protected void finalize() throws Throwable {
2286 if (DEBUG_RECYCLE) {
2287 if (mStack != null) {
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002288 Log.w(TAG, "Client did not call Parcel.recycle()", mStack);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002289 }
2290 }
2291 destroy();
2292 }
2293
Dianne Hackborn6aff9052009-05-22 13:20:23 -07002294 /* package */ void readMapInternal(Map outVal, int N,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002295 ClassLoader loader) {
2296 while (N > 0) {
2297 Object key = readValue(loader);
2298 Object value = readValue(loader);
2299 outVal.put(key, value);
2300 N--;
2301 }
2302 }
2303
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002304 /* package */ void readArrayMapInternal(ArrayMap outVal, int N,
2305 ClassLoader loader) {
Dianne Hackborne784d1e2013-09-20 18:13:52 -07002306 if (DEBUG_ARRAY_MAP) {
2307 RuntimeException here = new RuntimeException("here");
2308 here.fillInStackTrace();
2309 Log.d(TAG, "Reading " + N + " ArrayMap entries", here);
2310 }
Dianne Hackborn8aee64d2013-10-25 10:41:50 -07002311 int startPos;
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002312 while (N > 0) {
Dianne Hackborn8aee64d2013-10-25 10:41:50 -07002313 if (DEBUG_ARRAY_MAP) startPos = dataPosition();
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002314 Object key = readValue(loader);
2315 Object value = readValue(loader);
Dianne Hackborn8aee64d2013-10-25 10:41:50 -07002316 if (DEBUG_ARRAY_MAP) Log.d(TAG, " Read #" + (N-1) + " "
2317 + (dataPosition()-startPos) + " bytes: key=0x"
2318 + Integer.toHexString((key != null ? key.hashCode() : 0)) + " " + key);
Dianne Hackbornb87655b2013-07-17 19:06:22 -07002319 outVal.append(key, value);
2320 N--;
2321 }
2322 }
2323
Dianne Hackborne784d1e2013-09-20 18:13:52 -07002324 /* package */ void readArrayMapSafelyInternal(ArrayMap outVal, int N,
2325 ClassLoader loader) {
2326 if (DEBUG_ARRAY_MAP) {
2327 RuntimeException here = new RuntimeException("here");
2328 here.fillInStackTrace();
2329 Log.d(TAG, "Reading safely " + N + " ArrayMap entries", here);
2330 }
2331 while (N > 0) {
2332 Object key = readValue(loader);
2333 if (DEBUG_ARRAY_MAP) Log.d(TAG, " Read safe #" + (N-1) + ": key=0x"
2334 + (key != null ? key.hashCode() : 0) + " " + key);
2335 Object value = readValue(loader);
2336 outVal.put(key, value);
2337 N--;
2338 }
2339 }
2340
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002341 private void readListInternal(List outVal, int N,
2342 ClassLoader loader) {
2343 while (N > 0) {
2344 Object value = readValue(loader);
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002345 //Log.d(TAG, "Unmarshalling value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002346 outVal.add(value);
2347 N--;
2348 }
2349 }
2350
2351 private void readArrayInternal(Object[] outVal, int N,
2352 ClassLoader loader) {
2353 for (int i = 0; i < N; i++) {
2354 Object value = readValue(loader);
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002355 //Log.d(TAG, "Unmarshalling value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002356 outVal[i] = value;
2357 }
2358 }
2359
2360 private void readSparseArrayInternal(SparseArray outVal, int N,
2361 ClassLoader loader) {
2362 while (N > 0) {
2363 int key = readInt();
2364 Object value = readValue(loader);
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002365 //Log.i(TAG, "Unmarshalling key=" + key + " value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002366 outVal.append(key, value);
2367 N--;
2368 }
2369 }
2370
2371
2372 private void readSparseBooleanArrayInternal(SparseBooleanArray outVal, int N) {
2373 while (N > 0) {
2374 int key = readInt();
2375 boolean value = this.readByte() == 1;
Brad Fitzpatrick5b747192010-07-12 11:05:38 -07002376 //Log.i(TAG, "Unmarshalling key=" + key + " value=" + value);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002377 outVal.append(key, value);
2378 N--;
2379 }
2380 }
2381}