summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Tomasz Mikolajewski <mtomasz@google.com> 2017-01-05 05:03:29 +0000
committer Android (Google) Code Review <android-gerrit@google.com> 2017-01-05 05:03:35 +0000
commitccd496043dfc703cf9ee2011cee4b3534beed7b7 (patch)
tree7d472dcf88ad756e00bee8cf61ceee3b3a5672a5
parent2b8dfa11275500d40cc5884bef99e668c1dc3cf6 (diff)
parent099f95181d5fdf905d4a77c9a364c458030064b1 (diff)
Merge "Update API documentation about virtual files."
-rw-r--r--core/java/android/provider/DocumentsContract.java3
-rw-r--r--core/java/android/provider/DocumentsProvider.java4
2 files changed, 7 insertions, 0 deletions
diff --git a/core/java/android/provider/DocumentsContract.java b/core/java/android/provider/DocumentsContract.java
index 5a6940941698..ded715f38426 100644
--- a/core/java/android/provider/DocumentsContract.java
+++ b/core/java/android/provider/DocumentsContract.java
@@ -393,6 +393,9 @@ public final class DocumentsContract {
* Flag indicating that a document is virtual, and doesn't have byte
* representation in the MIME type specified as {@link #COLUMN_MIME_TYPE}.
*
+ * <p><em>Virtual documents must have at least one alternative streamable
+ * format via {@link DocumentsProvider#openTypedDocument}</em>
+ *
* @see #COLUMN_FLAGS
* @see #COLUMN_MIME_TYPE
* @see DocumentsProvider#openTypedDocument(String, String, Bundle,
diff --git a/core/java/android/provider/DocumentsProvider.java b/core/java/android/provider/DocumentsProvider.java
index 96c2556428b8..584f5fe494e1 100644
--- a/core/java/android/provider/DocumentsProvider.java
+++ b/core/java/android/provider/DocumentsProvider.java
@@ -575,6 +575,8 @@ public abstract class DocumentsProvider extends ContentProvider {
* <p>
* A provider may perform a conversion if the documents's MIME type is not
* matching the specified MIME type filter.
+ * <p>
+ * Virtual documents must have at least one streamable format.
*
* @param documentId the document to return.
* @param mimeTypeFilter the MIME type filter for the requested format. May
@@ -1044,6 +1046,8 @@ public abstract class DocumentsProvider extends ContentProvider {
* {@link #queryDocument(String, String[])} as long as it matches the filter and the document
* does not have the {@link Document#FLAG_VIRTUAL_DOCUMENT} flag set.
*
+ * <p>Virtual documents must have at least one streamable format.
+ *
* @see #getStreamTypes(Uri, String)
* @see #openTypedDocument(String, String, Bundle, CancellationSignal)
*/