Browse Source

doc: Progress

drake 2 years ago
parent
commit
c692f0cc72

+ 7 - 3
net/src/main/java/com/drake/net/component/Progress.kt

@@ -34,15 +34,15 @@ class Progress {
     var currentByteCount: Long = 0
         internal set
 
-    /** 当前已经完成的字节数 */
+    /** 全部字节数 */
     var totalByteCount: Long = 0
         internal set
 
-    /** 进度间隔时间内完成的字节数 */
+    /** 距离上次进度变化的新增字节数 */
     var intervalByteCount: Long = 0
         internal set
 
-    /** 距离上次进度变化间隔时间 */
+    /** 距离上次进度变化时间 */
     var intervalTime: Long = 0
         internal set
 
@@ -66,6 +66,10 @@ class Progress {
             }
         }
 
+    override fun toString(): String {
+        return "Progress(currentByteCount=$currentByteCount, totalByteCount=$totalByteCount, finish=$finish)"
+    }
+
     /**
      * 文件全部大小
      * 根据字节数自动显示内存单位, 例如 19MB 或者 27KB

+ 3 - 3
net/src/main/java/com/drake/net/interfaces/ProgressListener.kt

@@ -18,15 +18,15 @@ package com.drake.net.interfaces
 import com.drake.net.component.Progress
 
 /**
- * 进度监听器, 为下载和上传两者
+ * 进度监听器, 可能为下载或上传
  *
  * @param interval 进度监听器刷新的间隔时间, 单位为毫秒, 默认值为500ms
  */
 abstract class ProgressListener(var interval: Long = 500) {
-    // 上次触发监听器时的开机时间
+    // 上次进度变化的的开机时间
     var elapsedTime = 0L
 
-    // 距离上次触发监听器的间隔字节数
+    // 距离上次进度变化的新增字节数
     var intervalByteCount = 0L
 
     /**