Clarify javadoc about default mode
Bug: 273770317
Change-Id: Iaf11db2542944917ac9c52085cf40faf27b68105
Test: no
diff --git a/core/java/android/content/ContentProvider.java b/core/java/android/content/ContentProvider.java
index 31c02b8..fa99b59 100644
--- a/core/java/android/content/ContentProvider.java
+++ b/core/java/android/content/ContentProvider.java
@@ -2085,7 +2085,8 @@
*
* @param uri The URI whose file is to be opened.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
*
* @return Returns a new ParcelFileDescriptor which you can use to access
* the file.
@@ -2147,7 +2148,8 @@
*
* @param uri The URI whose file is to be opened.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
* @param signal A signal to cancel the operation in progress, or
* {@code null} if none. For example, if you are downloading a
* file from the network to service a "rw" mode request, you
@@ -2208,7 +2210,8 @@
*
* @param uri The URI whose file is to be opened.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
*
* @return Returns a new AssetFileDescriptor which you can use to access
* the file.
@@ -2262,7 +2265,8 @@
*
* @param uri The URI whose file is to be opened.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
* @param signal A signal to cancel the operation in progress, or
* {@code null} if none. For example, if you are downloading a
* file from the network to service a "rw" mode request, you
@@ -2294,7 +2298,8 @@
*
* @param uri The URI to be opened.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
*
* @return Returns a new ParcelFileDescriptor that can be used by the
* client to access the file.
diff --git a/core/java/android/content/ContentResolver.java b/core/java/android/content/ContentResolver.java
index feca7a0..b2cd7e9 100644
--- a/core/java/android/content/ContentResolver.java
+++ b/core/java/android/content/ContentResolver.java
@@ -1536,7 +1536,8 @@
/**
* Synonym for {@link #openOutputStream(Uri, String)
- * openOutputStream(uri, "w")}.
+ * openOutputStream(uri, "w")}. Please note the implementation of "w" is up to each
+ * Provider implementation and it may or may not truncate.
*
* @param uri The desired URI.
* @return an OutputStream or {@code null} if the provider recently crashed.
@@ -1562,7 +1563,8 @@
*
* @param uri The desired URI.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
* @return an OutputStream or {@code null} if the provider recently crashed.
* @throws FileNotFoundException if the provided URI could not be opened.
* @see #openAssetFileDescriptor(Uri, String)
@@ -1619,7 +1621,8 @@
*
* @param uri The desired URI to open.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
* @return Returns a new ParcelFileDescriptor pointing to the file or {@code null} if the
* provider recently crashed. You own this descriptor and are responsible for closing it
* when done.
@@ -1662,7 +1665,8 @@
*
* @param uri The desired URI to open.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
* @param cancellationSignal A signal to cancel the operation in progress,
* or null if none. If the operation is canceled, then
* {@link OperationCanceledException} will be thrown.
@@ -1756,7 +1760,8 @@
*
* @param uri The desired URI to open.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note the exact implementation of these may differ for each
+ * Provider implementation - for example, "w" may or may not truncate.
* @return Returns a new ParcelFileDescriptor pointing to the file or {@code null} if the
* provider recently crashed. You own this descriptor and are responsible for closing it
* when done.
@@ -1810,7 +1815,8 @@
*
* @param uri The desired URI to open.
* @param mode The string representation of the file mode. Can be "r", "w", "wt", "wa", "rw"
- * or "rwt". See{@link ParcelFileDescriptor#parseMode} for more details.
+ * or "rwt". Please note "w" is write only and "wt" is write and truncate.
+ * See{@link ParcelFileDescriptor#parseMode} for more details.
* @param cancellationSignal A signal to cancel the operation in progress, or null if
* none. If the operation is canceled, then
* {@link OperationCanceledException} will be thrown.
