summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--core/java/android/os/Parcelable.java22
1 files changed, 17 insertions, 5 deletions
diff --git a/core/java/android/os/Parcelable.java b/core/java/android/os/Parcelable.java
index 13b5de9e3a0d..c10abec7a80a 100644
--- a/core/java/android/os/Parcelable.java
+++ b/core/java/android/os/Parcelable.java
@@ -73,19 +73,31 @@ public interface Parcelable {
*/
public static final int PARCELABLE_ELIDE_DUPLICATES = 0x0002;
- /**
+ /*
* Bit masks for use with {@link #describeContents}: each bit represents a
* kind of object considered to have potential special significance when
* marshalled.
*/
+
+ /**
+ * Descriptor bit used with {@link #describeContents()}: indicates that
+ * the Parcelable object's flattened representation includes a file descriptor.
+ *
+ * @see #describeContents()
+ */
public static final int CONTENTS_FILE_DESCRIPTOR = 0x0001;
/**
- * Describe the kinds of special objects contained in this Parcelable's
- * marshalled representation.
+ * Describe the kinds of special objects contained in this Parcelable
+ * instance's marshaled representation. For example, if the object will
+ * include a file descriptor in the output of {@link #writeToParcel(Parcel, int)},
+ * the return value of this method must include the
+ * {@link #CONTENTS_FILE_DESCRIPTOR} bit.
*
- * @return a bitmask indicating the set of special object types marshalled
- * by the Parcelable.
+ * @return a bitmask indicating the set of special object types marshaled
+ * by this Parcelable object instance.
+ *
+ * @see #CONTENTS_FILE_DESCRIPTOR
*/
public int describeContents();