Update BlobStoreManager javadoc.

- Indicate that blob could be deleted even if the app
  acquires a lease.
- Indicate the meaning of passing 0 as blob expiry time.

Bug: 143559646
Test: atest cts/tests/BlobStore/src/com/android/cts/blob/BlobStoreManagerTest.java
Change-Id: I4deb72cb5b5500d42825781e329e9b2ec9839c7b
This commit is contained in:
Sudheer Shanka
2020-02-06 10:57:50 -08:00
parent 004e36da64
commit 86783e168d
2 changed files with 14 additions and 1 deletions

View File

@@ -129,7 +129,8 @@ public final class BlobHandle implements Parcelable {
* @param label a label indicating what the blob is, that can be surfaced to the user.
* @param expiryTimeMillis the time in secs after which the blob should be invalidated and not
* allowed to be accessed by any other app,
* in {@link System#currentTimeMillis()} timebase.
* in {@link System#currentTimeMillis()} timebase or {@code 0} to
* indicate that there is no expiry time associated with this blob.
* @param tag an opaque {@link String} associated with the blob. The length of the tag
* cannot be more than 128 characters.
*

View File

@@ -266,6 +266,9 @@ public class BlobStoreManager {
* <p> This lease information is persisted and calling this more than once will result in
* latest lease overriding any previous lease.
*
* <p> When an app acquires a lease on a blob, the System will try to keep this
* blob around but note that it can still be deleted if it was requested by the user.
*
* @param blobHandle the {@link BlobHandle} representing the blob that the caller wants to
* acquire a lease for.
* @param descriptionResId the resource id for a short description string that can be surfaced
@@ -319,6 +322,9 @@ public class BlobStoreManager {
* <p> This lease information is persisted and calling this more than once will result in
* latest lease overriding any previous lease.
*
* <p> When an app acquires a lease on a blob, the System will try to keep this
* blob around but note that it can still be deleted if it was requested by the user.
*
* @param blobHandle the {@link BlobHandle} representing the blob that the caller wants to
* acquire a lease for.
* @param description a short description string that can be surfaced
@@ -371,6 +377,9 @@ public class BlobStoreManager {
* <p> This lease information is persisted and calling this more than once will result in
* latest lease overriding any previous lease.
*
* <p> When an app acquires a lease on a blob, the System will try to keep this
* blob around but note that it can still be deleted if it was requested by the user.
*
* @param blobHandle the {@link BlobHandle} representing the blob that the caller wants to
* acquire a lease for.
* @param descriptionResId the resource id for a short description string that can be surfaced
@@ -412,6 +421,9 @@ public class BlobStoreManager {
* <p> This lease information is persisted and calling this more than once will result in
* latest lease overriding any previous lease.
*
* <p> When an app acquires a lease on a blob, the System will try to keep this
* blob around but note that it can still be deleted if it was requested by the user.
*
* @param blobHandle the {@link BlobHandle} representing the blob that the caller wants to
* acquire a lease for.
* @param description a short description string that can be surfaced