offline_items_collection : Added helper class to determine progress

chrome/android/java/src/org/chromium/chrome/browser/download/DownloadInfo.java

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.download;
 
 import android.graphics.Bitmap;
 
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.components.offline_items_collection.ContentId;
 import org.chromium.components.offline_items_collection.LegacyHelpers;
 import org.chromium.components.offline_items_collection.OfflineItem;
+import org.chromium.components.offline_items_collection.OfflineItem.Progress;
+import org.chromium.components.offline_items_collection.OfflineItemProgressUnit;
 import org.chromium.components.offline_items_collection.OfflineItemState;
 import org.chromium.components.offline_items_collection.OfflineItemVisuals;
 import org.chromium.content_public.browser.DownloadState;
 
 /**
  * Class representing the state of a single download.
  */
 public final class DownloadInfo {
     private final String mUrl;
     private final String mUserAgent;
     private final String mMimeType;
     private final String mCookie;
     private final String mFileName;
     private final String mDescription;
     private final String mFilePath;
     private final String mReferrer;
     private final String mOriginalUrl;
     private final long mBytesReceived;
     private final String mDownloadGuid;
     private final boolean mHasUserGesture;
     private final String mContentDisposition;
     private final boolean mIsGETRequest;
-    private final int mPercentCompleted;
+    private final Progress mProgress;
     private final long mTimeRemainingInMillis;
     private final boolean mIsResumable;
     private final boolean mIsPaused;
     private final boolean mIsOffTheRecord;
     private final boolean mIsOfflinePage;
     private final int mState;
     private final long mLastAccessTime;
 
     // New variables to assist with the migration to OfflineItems.
     private final ContentId mContentId;
     private final boolean mIsOpenable;
     private final boolean mIsTransient;
     private final Bitmap mIcon;
 
     private DownloadInfo(Builder builder) {
         mUrl = builder.mUrl;
         mUserAgent = builder.mUserAgent;
         mMimeType = builder.mMimeType;
         mCookie = builder.mCookie;
         mFileName = builder.mFileName;
         mDescription = builder.mDescription;
         mFilePath = builder.mFilePath;
         mReferrer = builder.mReferrer;
         mOriginalUrl = builder.mOriginalUrl;
         mBytesReceived = builder.mBytesReceived;
         mDownloadGuid = builder.mDownloadGuid;
         mHasUserGesture = builder.mHasUserGesture;
         mIsGETRequest = builder.mIsGETRequest;
         mContentDisposition = builder.mContentDisposition;
-        mPercentCompleted = builder.mPercentCompleted;
+        mProgress = builder.mProgress;
         mTimeRemainingInMillis = builder.mTimeRemainingInMillis;
         mIsResumable = builder.mIsResumable;
         mIsPaused = builder.mIsPaused;
         mIsOffTheRecord = builder.mIsOffTheRecord;
         mIsOfflinePage = builder.mIsOfflinePage;
         mState = builder.mState;
         mLastAccessTime = builder.mLastAccessTime;
 
         if (builder.mContentId != null) {
             mContentId = builder.mContentId;
@@ skipping 54 matching lines @@
     }
 
     public boolean hasUserGesture() {
         return mHasUserGesture;
     }
 
     public String getContentDisposition() {
         return mContentDisposition;
     }
 
-    /**
-     * @return percent completed as an integer, -1 if there is no download progress.
-     */
-    public int getPercentCompleted() {
-        return mPercentCompleted;
+    public Progress getProgress() {
+        return mProgress;
     }
 
     /**
      * @return Remaining download time in milliseconds or -1 if it is unknown.
      */
     public long getTimeRemainingInMillis() {
         return mTimeRemainingInMillis;
     }
 
     public boolean isResumable() {
@@ skipping 70 matching lines @@
                 .setDescription(item.description)
                 .setIsTransient(item.isTransient)
                 .setLastAccessTime(item.lastAccessedTimeMs)
                 .setIsOpenable(item.isOpenable)
                 .setOriginalUrl(item.originalUrl)
                 .setIsOffTheRecord(item.isOffTheRecord)
                 .setState(state)
                 .setIsPaused(item.state == OfflineItemState.PAUSED)
                 .setIsResumable(item.isResumable)
                 .setBytesReceived(item.receivedBytes)
-                .setPercentCompleted(item.percentCompleted)
+                .setProgress(item.progress)
                 .setTimeRemainingInMillis(item.timeRemainingMs)
                 .setIcon(visuals == null ? null : visuals.icon)
                 .build();
     }
 
     /**
      * Helper class for building the DownloadInfo object.
      */
     public static class Builder {
         private String mUrl;
         private String mUserAgent;
         private String mMimeType;
         private String mCookie;
         private String mFileName;
         private String mDescription;
         private String mFilePath;
         private String mReferrer;
         private String mOriginalUrl;
         private long mBytesReceived;
         private boolean mIsGETRequest;
         private String mDownloadGuid;
         private boolean mHasUserGesture;
         private String mContentDisposition;
-        private int mPercentCompleted = -1;
+        private Progress mProgress = Progress.createIndeterminateProgress();
         private long mTimeRemainingInMillis;
         private boolean mIsResumable = true;
         private boolean mIsPaused;
         private boolean mIsOffTheRecord;
         private boolean mIsOfflinePage;
         private int mState = DownloadState.IN_PROGRESS;
         private long mLastAccessTime;
         private ContentId mContentId;
         private boolean mIsOpenable = true;
         private boolean mIsTransient;
@@ skipping 62 matching lines @@
         public Builder setHasUserGesture(boolean hasUserGesture) {
             mHasUserGesture = hasUserGesture;
             return this;
         }
 
         public Builder setContentDisposition(String contentDisposition) {
             mContentDisposition = contentDisposition;
             return this;
         }
 
-        public Builder setPercentCompleted(int percentCompleted) {
-            assert percentCompleted <= 100;
-            mPercentCompleted = percentCompleted;
+        public Builder setProgress(OfflineItem.Progress progress) {
+            mProgress = progress;
             return this;
         }
 
         public Builder setTimeRemainingInMillis(long timeRemainingInMillis) {
             mTimeRemainingInMillis = timeRemainingInMillis;
             return this;
         }
 
         public Builder setIsResumable(boolean isResumable) {
             mIsResumable = isResumable;
@@ skipping 63 matching lines @@
                     .setFileName(downloadInfo.getFileName())
                     .setDescription(downloadInfo.getDescription())
                     .setFilePath(downloadInfo.getFilePath())
                     .setReferrer(downloadInfo.getReferrer())
                     .setOriginalUrl(downloadInfo.getOriginalUrl())
                     .setBytesReceived(downloadInfo.getBytesReceived())
                     .setDownloadGuid(downloadInfo.getDownloadGuid())
                     .setHasUserGesture(downloadInfo.hasUserGesture())
                     .setContentDisposition(downloadInfo.getContentDisposition())
                     .setIsGETRequest(downloadInfo.isGETRequest())
-                    .setPercentCompleted(downloadInfo.getPercentCompleted())
+                    .setProgress(downloadInfo.getProgress())
                     .setTimeRemainingInMillis(downloadInfo.getTimeRemainingInMillis())
                     .setIsResumable(downloadInfo.isResumable())
                     .setIsPaused(downloadInfo.isPaused())
                     .setIsOffTheRecord(downloadInfo.isOffTheRecord())
                     .setIsOfflinePage(downloadInfo.isOfflinePage())
                     .setState(downloadInfo.state())
                     .setLastAccessTime(downloadInfo.getLastAccessTime())
                     .setIcon(downloadInfo.getIcon());
             return builder;
         }
     }
 
     @CalledByNative
     private static DownloadInfo createDownloadInfo(String downloadGuid, String fileName,
             String filePath, String url, String mimeType, long bytesReceived, boolean isIncognito,
             int state, int percentCompleted, boolean isPaused, boolean hasUserGesture,
             boolean isResumable, String originalUrl, String referrerUrl, long timeRemainingInMs,
             long lastAccessTime) {
         String remappedMimeType = ChromeDownloadDelegate.remapGenericMimeType(
                 mimeType, url, fileName);
+        Progress progress = new Progress(percentCompleted, percentCompleted == -1 ? null : 100L,
+                OfflineItemProgressUnit.PERCENTAGE);
         return new DownloadInfo.Builder()
                 .setBytesReceived(bytesReceived)
                 .setDescription(fileName)
                 .setDownloadGuid(downloadGuid)
                 .setFileName(fileName)
                 .setFilePath(filePath)
                 .setHasUserGesture(hasUserGesture)
                 .setIsOffTheRecord(isIncognito)
                 .setIsPaused(isPaused)
                 .setIsResumable(isResumable)
                 .setMimeType(remappedMimeType)
                 .setOriginalUrl(originalUrl)
-                .setPercentCompleted(percentCompleted)
+                .setProgress(progress)
                 .setReferrer(referrerUrl)
                 .setState(state)
                 .setTimeRemainingInMillis(timeRemainingInMs)
                 .setLastAccessTime(lastAccessTime)
                 .setUrl(url)
                 .build();
     }
 }