Merge "Fix MbmsDownloadSession documentation"

This commit is contained in:
Hall Liu
2018-05-31 21:16:05 +00:00
committed by Gerrit Code Review

View File

@@ -207,23 +207,25 @@ public class MbmsDownloadSession implements AutoCloseable {
public static final int STATUS_UNKNOWN = 0; public static final int STATUS_UNKNOWN = 0;
/** /**
* Indicates that the file is actively downloading. * Indicates that the file is actively being downloaded.
*/ */
public static final int STATUS_ACTIVELY_DOWNLOADING = 1; public static final int STATUS_ACTIVELY_DOWNLOADING = 1;
/** /**
* TODO: I don't know... * Indicates that the file is awaiting the next download or repair operations. When a more
* precise status is known, the status will change to either {@link #STATUS_PENDING_REPAIR} or
* {@link #STATUS_PENDING_DOWNLOAD_WINDOW}.
*/ */
public static final int STATUS_PENDING_DOWNLOAD = 2; public static final int STATUS_PENDING_DOWNLOAD = 2;
/** /**
* Indicates that the file is being repaired after the download being interrupted. * Indicates that the file is awaiting file repair after the download has ended.
*/ */
public static final int STATUS_PENDING_REPAIR = 3; public static final int STATUS_PENDING_REPAIR = 3;
/** /**
* Indicates that the file is waiting to download because its download window has not yet * Indicates that the file is waiting to download because its download window has not yet
* started. * started and is scheduled for a future time.
*/ */
public static final int STATUS_PENDING_DOWNLOAD_WINDOW = 4; public static final int STATUS_PENDING_DOWNLOAD_WINDOW = 4;
@@ -609,6 +611,9 @@ public class MbmsDownloadSession implements AutoCloseable {
* If the operation encountered an error, the error code will be delivered via * If the operation encountered an error, the error code will be delivered via
* {@link MbmsDownloadSessionCallback#onError}. * {@link MbmsDownloadSessionCallback#onError}.
* *
* Repeated calls to this method for the same {@link DownloadRequest} will replace the
* previously registered listener.
*
* @param request The {@link DownloadRequest} that you want updates on. * @param request The {@link DownloadRequest} that you want updates on.
* @param executor The {@link Executor} on which calls to {@code listener } should be executed. * @param executor The {@link Executor} on which calls to {@code listener } should be executed.
* @param listener The listener that should be called when the middleware has information to * @param listener The listener that should be called when the middleware has information to
@@ -659,6 +664,9 @@ public class MbmsDownloadSession implements AutoCloseable {
* If the operation encountered an error, the error code will be delivered via * If the operation encountered an error, the error code will be delivered via
* {@link MbmsDownloadSessionCallback#onError}. * {@link MbmsDownloadSessionCallback#onError}.
* *
* Repeated calls to this method for the same {@link DownloadRequest} will replace the
* previously registered listener.
*
* @param request The {@link DownloadRequest} provided during registration * @param request The {@link DownloadRequest} provided during registration
* @param listener The listener provided during registration. * @param listener The listener provided during registration.
*/ */