From 138da6d51900e831ee4bcaee885bb373655d7b90 Mon Sep 17 00:00:00 2001 From: olly Date: Thu, 18 Apr 2019 18:26:00 +0100 Subject: [PATCH] Rename manualStopReason to stopReason PiperOrigin-RevId: 244210737 --- .../offline/ActionFileUpgradeUtil.java | 4 +- .../offline/DefaultDownloadIndex.java | 20 ++-- .../android/exoplayer2/offline/Download.java | 20 ++-- .../exoplayer2/offline/DownloadManager.java | 93 +++++++++---------- .../exoplayer2/offline/DownloadService.java | 89 ++++++++---------- .../offline/WritableDownloadIndex.java | 16 ++-- .../offline/DefaultDownloadIndexTest.java | 47 +++++----- .../exoplayer2/offline/DownloadBuilder.java | 8 +- .../offline/DownloadManagerTest.java | 28 +++--- 9 files changed, 153 insertions(+), 172 deletions(-) diff --git a/library/core/src/main/java/com/google/android/exoplayer2/offline/ActionFileUpgradeUtil.java b/library/core/src/main/java/com/google/android/exoplayer2/offline/ActionFileUpgradeUtil.java index 0a37fe3a80..51996ed284 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/offline/ActionFileUpgradeUtil.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/offline/ActionFileUpgradeUtil.java @@ -90,7 +90,7 @@ public final class ActionFileUpgradeUtil { DownloadRequest request, DefaultDownloadIndex downloadIndex) throws IOException { Download download = downloadIndex.getDownload(request.id); if (download != null) { - download = DownloadManager.mergeRequest(download, request, download.manualStopReason); + download = DownloadManager.mergeRequest(download, request, download.stopReason); } else { long nowMs = System.currentTimeMillis(); download = @@ -98,7 +98,7 @@ public final class ActionFileUpgradeUtil { request, STATE_QUEUED, Download.FAILURE_REASON_NONE, - Download.MANUAL_STOP_REASON_NONE, + Download.STOP_REASON_NONE, /* startTimeMs= */ nowMs, /* updateTimeMs= */ nowMs); } diff --git a/library/core/src/main/java/com/google/android/exoplayer2/offline/DefaultDownloadIndex.java b/library/core/src/main/java/com/google/android/exoplayer2/offline/DefaultDownloadIndex.java index fc1518e5c3..a2caff3ff1 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/offline/DefaultDownloadIndex.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/offline/DefaultDownloadIndex.java @@ -57,7 +57,7 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { private static final String COLUMN_DOWNLOADED_BYTES = "downloaded_bytes"; private static final String COLUMN_TOTAL_BYTES = "total_bytes"; private static final String COLUMN_FAILURE_REASON = "failure_reason"; - private static final String COLUMN_MANUAL_STOP_REASON = "manual_stop_reason"; + private static final String COLUMN_STOP_REASON = "manual_stop_reason"; private static final String COLUMN_START_TIME_MS = "start_time_ms"; private static final String COLUMN_UPDATE_TIME_MS = "update_time_ms"; @@ -82,7 +82,7 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { private static final int COLUMN_INDEX_DOWNLOADED_BYTES = 8; private static final int COLUMN_INDEX_TOTAL_BYTES = 9; private static final int COLUMN_INDEX_FAILURE_REASON = 10; - private static final int COLUMN_INDEX_MANUAL_STOP_REASON = 11; + private static final int COLUMN_INDEX_STOP_REASON = 11; private static final int COLUMN_INDEX_START_TIME_MS = 12; private static final int COLUMN_INDEX_UPDATE_TIME_MS = 13; @@ -103,7 +103,7 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { COLUMN_DOWNLOADED_BYTES, COLUMN_TOTAL_BYTES, COLUMN_FAILURE_REASON, - COLUMN_MANUAL_STOP_REASON, + COLUMN_STOP_REASON, COLUMN_START_TIME_MS, COLUMN_UPDATE_TIME_MS }; @@ -135,7 +135,7 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { + " INTEGER NOT NULL," + COLUMN_NOT_MET_REQUIREMENTS + " INTEGER NOT NULL," - + COLUMN_MANUAL_STOP_REASON + + COLUMN_STOP_REASON + " INTEGER NOT NULL," + COLUMN_START_TIME_MS + " INTEGER NOT NULL," @@ -202,7 +202,7 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { values.put(COLUMN_FAILURE_REASON, download.failureReason); values.put(COLUMN_STOP_FLAGS, 0); values.put(COLUMN_NOT_MET_REQUIREMENTS, 0); - values.put(COLUMN_MANUAL_STOP_REASON, download.manualStopReason); + values.put(COLUMN_STOP_REASON, download.stopReason); values.put(COLUMN_START_TIME_MS, download.startTimeMs); values.put(COLUMN_UPDATE_TIME_MS, download.updateTimeMs); try { @@ -224,11 +224,11 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { } @Override - public void setManualStopReason(int manualStopReason) throws DatabaseIOException { + public void setStopReason(int stopReason) throws DatabaseIOException { ensureInitialized(); try { ContentValues values = new ContentValues(); - values.put(COLUMN_MANUAL_STOP_REASON, manualStopReason); + values.put(COLUMN_STOP_REASON, stopReason); SQLiteDatabase writableDatabase = databaseProvider.getWritableDatabase(); writableDatabase.update(TABLE_NAME, values, WHERE_STATE_TERMINAL, /* whereArgs= */ null); } catch (SQLException e) { @@ -237,11 +237,11 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { } @Override - public void setManualStopReason(String id, int manualStopReason) throws DatabaseIOException { + public void setStopReason(String id, int stopReason) throws DatabaseIOException { ensureInitialized(); try { ContentValues values = new ContentValues(); - values.put(COLUMN_MANUAL_STOP_REASON, manualStopReason); + values.put(COLUMN_STOP_REASON, stopReason); SQLiteDatabase writableDatabase = databaseProvider.getWritableDatabase(); writableDatabase.update( TABLE_NAME, values, WHERE_STATE_TERMINAL + " AND " + WHERE_ID_EQUALS, new String[] {id}); @@ -332,7 +332,7 @@ public final class DefaultDownloadIndex implements WritableDownloadIndex { request, cursor.getInt(COLUMN_INDEX_STATE), cursor.getInt(COLUMN_INDEX_FAILURE_REASON), - cursor.getInt(COLUMN_INDEX_MANUAL_STOP_REASON), + cursor.getInt(COLUMN_INDEX_STOP_REASON), cursor.getLong(COLUMN_INDEX_START_TIME_MS), cursor.getLong(COLUMN_INDEX_UPDATE_TIME_MS), cachingCounters); diff --git a/library/core/src/main/java/com/google/android/exoplayer2/offline/Download.java b/library/core/src/main/java/com/google/android/exoplayer2/offline/Download.java index b29abde24b..343b9d6a49 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/offline/Download.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/offline/Download.java @@ -46,7 +46,7 @@ public final class Download { // Important: These constants are persisted into DownloadIndex. Do not change them. /** The download is waiting to be started. */ public static final int STATE_QUEUED = 0; - /** The download is stopped for a specified {@link #manualStopReason}. */ + /** The download is stopped for a specified {@link #stopReason}. */ public static final int STATE_STOPPED = 1; /** The download is currently started. */ public static final int STATE_DOWNLOADING = 2; @@ -69,8 +69,8 @@ public final class Download { /** The download is failed because of unknown reason. */ public static final int FAILURE_REASON_UNKNOWN = 1; - /** The download isn't manually stopped. */ - public static final int MANUAL_STOP_REASON_NONE = 0; + /** The download isn't stopped. */ + public static final int STOP_REASON_NONE = 0; /** Returns the state string for the given state value. */ public static String getStateString(@State int state) { @@ -108,8 +108,8 @@ public final class Download { * #FAILURE_REASON_NONE}. */ @FailureReason public final int failureReason; - /** The reason the download is manually stopped, or {@link #MANUAL_STOP_REASON_NONE}. */ - public final int manualStopReason; + /** The reason the download is stopped, or {@link #STOP_REASON_NONE}. */ + public final int stopReason; /* package */ CachingCounters counters; @@ -117,14 +117,14 @@ public final class Download { DownloadRequest request, @State int state, @FailureReason int failureReason, - int manualStopReason, + int stopReason, long startTimeMs, long updateTimeMs) { this( request, state, failureReason, - manualStopReason, + stopReason, startTimeMs, updateTimeMs, new CachingCounters()); @@ -134,19 +134,19 @@ public final class Download { DownloadRequest request, @State int state, @FailureReason int failureReason, - int manualStopReason, + int stopReason, long startTimeMs, long updateTimeMs, CachingCounters counters) { Assertions.checkNotNull(counters); Assertions.checkState((failureReason == FAILURE_REASON_NONE) == (state != STATE_FAILED)); - if (manualStopReason != 0) { + if (stopReason != 0) { Assertions.checkState(state != STATE_DOWNLOADING && state != STATE_QUEUED); } this.request = request; this.state = state; this.failureReason = failureReason; - this.manualStopReason = manualStopReason; + this.stopReason = stopReason; this.startTimeMs = startTimeMs; this.updateTimeMs = updateTimeMs; this.counters = counters; diff --git a/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadManager.java b/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadManager.java index df958f8691..497e3476af 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadManager.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadManager.java @@ -17,7 +17,6 @@ package com.google.android.exoplayer2.offline; import static com.google.android.exoplayer2.offline.Download.FAILURE_REASON_NONE; import static com.google.android.exoplayer2.offline.Download.FAILURE_REASON_UNKNOWN; -import static com.google.android.exoplayer2.offline.Download.MANUAL_STOP_REASON_NONE; import static com.google.android.exoplayer2.offline.Download.STATE_COMPLETED; import static com.google.android.exoplayer2.offline.Download.STATE_DOWNLOADING; import static com.google.android.exoplayer2.offline.Download.STATE_FAILED; @@ -25,6 +24,7 @@ import static com.google.android.exoplayer2.offline.Download.STATE_QUEUED; import static com.google.android.exoplayer2.offline.Download.STATE_REMOVING; import static com.google.android.exoplayer2.offline.Download.STATE_RESTARTING; import static com.google.android.exoplayer2.offline.Download.STATE_STOPPED; +import static com.google.android.exoplayer2.offline.Download.STOP_REASON_NONE; import android.content.Context; import android.os.Handler; @@ -128,7 +128,7 @@ public final class DownloadManager { private static final int MSG_INITIALIZE = 0; private static final int MSG_SET_DOWNLOADS_STARTED = 1; private static final int MSG_SET_NOT_MET_REQUIREMENTS = 2; - private static final int MSG_SET_MANUAL_STOP_REASON = 3; + private static final int MSG_SET_STOP_REASON = 3; private static final int MSG_ADD_DOWNLOAD = 4; private static final int MSG_REMOVE_DOWNLOAD = 5; private static final int MSG_DOWNLOAD_THREAD_STOPPED = 6; @@ -346,10 +346,7 @@ public final class DownloadManager { return Collections.unmodifiableList(new ArrayList<>(downloads)); } - /** - * Starts all downloads except those that are manually stopped (i.e. have a non-zero {@link - * Download#manualStopReason}). - */ + /** Starts all downloads except those that have a non-zero {@link Download#stopReason}. */ public void startDownloads() { pendingMessages++; internalHandler @@ -366,17 +363,17 @@ public final class DownloadManager { } /** - * Sets the manual stop reason for one or all downloads. To clear the manual stop reason, pass - * {@link Download#MANUAL_STOP_REASON_NONE}. + * Sets the stop reason for one or all downloads. To clear the stop reason, pass {@link + * Download#STOP_REASON_NONE}. * - * @param id The content id of the download to update, or {@code null} to set the manual stop - * reason for all downloads. - * @param manualStopReason The manual stop reason, or {@link Download#MANUAL_STOP_REASON_NONE}. + * @param id The content id of the download to update, or {@code null} to set the stop reason for + * all downloads. + * @param stopReason The stop reason, or {@link Download#STOP_REASON_NONE}. */ - public void setManualStopReason(@Nullable String id, int manualStopReason) { + public void setStopReason(@Nullable String id, int stopReason) { pendingMessages++; internalHandler - .obtainMessage(MSG_SET_MANUAL_STOP_REASON, manualStopReason, /* unused */ 0, id) + .obtainMessage(MSG_SET_STOP_REASON, stopReason, /* unused */ 0, id) .sendToTarget(); } @@ -386,20 +383,20 @@ public final class DownloadManager { * @param request The download request. */ public void addDownload(DownloadRequest request) { - addDownload(request, Download.MANUAL_STOP_REASON_NONE); + addDownload(request, Download.STOP_REASON_NONE); } /** - * Adds a download defined by the given request and with the specified manual stop reason. + * Adds a download defined by the given request and with the specified stop reason. * * @param request The download request. - * @param manualStopReason An initial manual stop reason for the download, or {@link - * Download#MANUAL_STOP_REASON_NONE} if the download should be started. + * @param stopReason An initial stop reason for the download, or {@link Download#STOP_REASON_NONE} + * if the download should be started. */ - public void addDownload(DownloadRequest request, int manualStopReason) { + public void addDownload(DownloadRequest request, int stopReason) { pendingMessages++; internalHandler - .obtainMessage(MSG_ADD_DOWNLOAD, manualStopReason, /* unused */ 0, request) + .obtainMessage(MSG_ADD_DOWNLOAD, stopReason, /* unused */ 0, request) .sendToTarget(); } @@ -552,15 +549,15 @@ public final class DownloadManager { notMetRequirements = message.arg1; setNotMetRequirementsInternal(notMetRequirements); break; - case MSG_SET_MANUAL_STOP_REASON: + case MSG_SET_STOP_REASON: String id = (String) message.obj; - int manualStopReason = message.arg1; - setManualStopReasonInternal(id, manualStopReason); + int stopReason = message.arg1; + setStopReasonInternal(id, stopReason); break; case MSG_ADD_DOWNLOAD: DownloadRequest request = (DownloadRequest) message.obj; - manualStopReason = message.arg1; - addDownloadInternal(request, manualStopReason); + stopReason = message.arg1; + addDownloadInternal(request, stopReason); break; case MSG_REMOVE_DOWNLOAD: id = (String) message.obj; @@ -629,34 +626,34 @@ public final class DownloadManager { } } - private void setManualStopReasonInternal(@Nullable String id, int manualStopReason) { + private void setStopReasonInternal(@Nullable String id, int stopReason) { if (id != null) { DownloadInternal downloadInternal = getDownload(id); if (downloadInternal != null) { - logd("download manual stop reason is set to : " + manualStopReason, downloadInternal); - downloadInternal.setManualStopReason(manualStopReason); + logd("download stop reason is set to : " + stopReason, downloadInternal); + downloadInternal.setStopReason(stopReason); return; } } else { for (int i = 0; i < downloadInternals.size(); i++) { - downloadInternals.get(i).setManualStopReason(manualStopReason); + downloadInternals.get(i).setStopReason(stopReason); } } try { if (id != null) { - downloadIndex.setManualStopReason(id, manualStopReason); + downloadIndex.setStopReason(id, stopReason); } else { - downloadIndex.setManualStopReason(manualStopReason); + downloadIndex.setStopReason(stopReason); } } catch (IOException e) { - Log.e(TAG, "setManualStopReason failed", e); + Log.e(TAG, "setStopReason failed", e); } } - private void addDownloadInternal(DownloadRequest request, int manualStopReason) { + private void addDownloadInternal(DownloadRequest request, int stopReason) { DownloadInternal downloadInternal = getDownload(request.id); if (downloadInternal != null) { - downloadInternal.addRequest(request, manualStopReason); + downloadInternal.addRequest(request, stopReason); logd("Request is added to existing download", downloadInternal); } else { Download download = loadDownload(request.id); @@ -665,14 +662,14 @@ public final class DownloadManager { download = new Download( request, - manualStopReason != Download.MANUAL_STOP_REASON_NONE ? STATE_STOPPED : STATE_QUEUED, + stopReason != Download.STOP_REASON_NONE ? STATE_STOPPED : STATE_QUEUED, Download.FAILURE_REASON_NONE, - manualStopReason, + stopReason, /* startTimeMs= */ nowMs, /* updateTimeMs= */ nowMs); logd("Download state is created for " + request.id); } else { - download = mergeRequest(download, request, manualStopReason); + download = mergeRequest(download, request, stopReason); logd("Download state is loaded for " + request.id); } addDownloadForState(download); @@ -820,11 +817,11 @@ public final class DownloadManager { } /* package */ static Download mergeRequest( - Download download, DownloadRequest request, int manualStopReason) { + Download download, DownloadRequest request, int stopReason) { @Download.State int state = download.state; if (state == STATE_REMOVING || state == STATE_RESTARTING) { state = STATE_RESTARTING; - } else if (manualStopReason != MANUAL_STOP_REASON_NONE) { + } else if (stopReason != STOP_REASON_NONE) { state = STATE_STOPPED; } else { state = STATE_QUEUED; @@ -835,7 +832,7 @@ public final class DownloadManager { download.request.copyWithMergedRequest(request), state, FAILURE_REASON_NONE, - manualStopReason, + stopReason, startTimeMs, /* updateTimeMs= */ nowMs, download.counters); @@ -846,7 +843,7 @@ public final class DownloadManager { download.request, state, FAILURE_REASON_NONE, - download.manualStopReason, + download.stopReason, download.startTimeMs, /* updateTimeMs= */ System.currentTimeMillis(), download.counters); @@ -882,21 +879,21 @@ public final class DownloadManager { // TODO: Get rid of these and use download directly. @Download.State private int state; - private int manualStopReason; + private int stopReason; @MonotonicNonNull @Download.FailureReason private int failureReason; private DownloadInternal(DownloadManager downloadManager, Download download) { this.downloadManager = downloadManager; this.download = download; - manualStopReason = download.manualStopReason; + stopReason = download.stopReason; } private void initialize() { initialize(download.state); } - public void addRequest(DownloadRequest newRequest, int manualStopReason) { - download = mergeRequest(download, newRequest, manualStopReason); + public void addRequest(DownloadRequest newRequest, int stopReason) { + download = mergeRequest(download, newRequest, stopReason); initialize(); } @@ -910,7 +907,7 @@ public final class DownloadManager { download.request, state, state != STATE_FAILED ? FAILURE_REASON_NONE : failureReason, - manualStopReason, + stopReason, download.startTimeMs, /* updateTimeMs= */ System.currentTimeMillis(), download.counters); @@ -934,8 +931,8 @@ public final class DownloadManager { } } - public void setManualStopReason(int manualStopReason) { - this.manualStopReason = manualStopReason; + public void setStopReason(int stopReason) { + this.stopReason = stopReason; updateStopState(); } @@ -981,7 +978,7 @@ public final class DownloadManager { } private boolean canStart() { - return downloadManager.canStartDownloads() && manualStopReason == MANUAL_STOP_REASON_NONE; + return downloadManager.canStartDownloads() && stopReason == STOP_REASON_NONE; } private void startOrQueue() { diff --git a/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java b/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java index 6922d6a787..fa74afacb3 100644 --- a/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java +++ b/library/core/src/main/java/com/google/android/exoplayer2/offline/DownloadService.java @@ -15,7 +15,7 @@ */ package com.google.android.exoplayer2.offline; -import static com.google.android.exoplayer2.offline.Download.MANUAL_STOP_REASON_NONE; +import static com.google.android.exoplayer2.offline.Download.STOP_REASON_NONE; import android.app.Notification; import android.app.Service; @@ -58,16 +58,15 @@ public abstract class DownloadService extends Service { * */ public static final String ACTION_ADD = "com.google.android.exoplayer.downloadService.action.ADD"; /** - * Starts all downloads except those that are manually stopped (i.e. have a non-zero {@link - * Download#manualStopReason}). Extras: + * Starts all downloads except those that have a non-zero {@link Download#stopReason}. Extras: * *