minor internal changes in OfflineService; added OfflineRegion.getName and OfflineRegion.convertToString extensions

xit0c · xit0c · commit bd05361a06b6 · 2020-08-28T13:24:57.000+02:00
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ An alternative to [Mapbox offline plugin](https://github.com/mapbox/mapbox-plugi
 
 This plugin is published to [Bintray's JCenter](https://bintray.com/bintray/jcenter). Include it in your `build.gradle` file with
 ```gradle
-implementation 'dev.micheleferretti:mapbox-plugin-offline:2.0.13'
+implementation 'dev.micheleferretti:mapbox-plugin-offline:2.1.0'
 ```
 
 ## Usage
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/alltypes/index.md b/docs/alltypes/index.md
@@ -41,6 +41,11 @@ This `BroadcastReceiver` can be used to intercept [OfflineService](../dev.michel
 events and monitor active downloads.
 
 
+| (extensions in package dev.micheleferretti.mapboxpluginoffline.utils)
+
+##### [com.mapbox.mapboxsdk.offline.OfflineRegion](../dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/index.md)
+
+
 | (extensions in package dev.micheleferretti.mapboxpluginoffline.utils)
 
 ##### [com.mapbox.mapboxsdk.offline.OfflineRegionDefinition](../dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/index.md)
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/android.os.-bundle/require-long.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/android.os.-bundle/require-long.md
@@ -2,7 +2,7 @@
 
 # requireLong
 
-`fun `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`.requireLong(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L14)
+`fun `[`Bundle`](https://developer.android.com/reference/android/os/Bundle.html)`.requireLong(key: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Long`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L15)
 
 Returns the value associated with the given key, if exists and is of the desired type. Otherwise throws.
 
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/convert-to-string.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/convert-to-string.md
@@ -2,7 +2,7 @@
 
 # convertToString
 
-`fun OfflineRegionDefinition.convertToString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L20)
+`fun OfflineRegionDefinition.convertToString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L38)
 
 Returns a `String` representation of this object.
 
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/get-camera-position.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/get-camera-position.md
@@ -2,7 +2,7 @@
 
 # getCameraPosition
 
-`fun OfflineRegionDefinition.getCameraPosition(): CameraPosition!` [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L34)
+`fun OfflineRegionDefinition.getCameraPosition(): CameraPosition!` [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L52)
 
 Returns a `CameraPosition` built with this definition data.
 
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/convert-to-string.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/convert-to-string.md
@@ -0,0 +1,11 @@
+[mapboxpluginoffline](../../index.md) / [dev.micheleferretti.mapboxpluginoffline.utils](../index.md) / [com.mapbox.mapboxsdk.offline.OfflineRegion](index.md) / [convertToString](./convert-to-string.md)
+
+# convertToString
+
+`fun OfflineRegion.convertToString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L21)
+
+Returns a `String` representation of this object.
+
+**Return**
+a `String` representation of this object.
+
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/get-name.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/get-name.md
@@ -0,0 +1,11 @@
+[mapboxpluginoffline](../../index.md) / [dev.micheleferretti.mapboxpluginoffline.utils](../index.md) / [com.mapbox.mapboxsdk.offline.OfflineRegion](index.md) / [getName](./get-name.md)
+
+# getName
+
+`fun OfflineRegion.getName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt#L32)
+
+Returns the region name converting `metadata` with [OfflineUtils.convertRegionName](../-offline-utils/convert-region-name.md).
+
+**Return**
+the region name converting `metadata` with [OfflineUtils.convertRegionName](../-offline-utils/convert-region-name.md).
+
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/index.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/index.md
@@ -0,0 +1,8 @@
+[mapboxpluginoffline](../../index.md) / [dev.micheleferretti.mapboxpluginoffline.utils](../index.md) / [com.mapbox.mapboxsdk.offline.OfflineRegion](./index.md)
+
+### Extensions for com.mapbox.mapboxsdk.offline.OfflineRegion
+
+| Name | Summary |
+|---|---|
+| [convertToString](convert-to-string.md) | Returns a `String` representation of this object.`fun OfflineRegion.convertToString(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [getName](get-name.md) | Returns the region name converting `metadata` with [OfflineUtils.convertRegionName](../-offline-utils/convert-region-name.md).`fun OfflineRegion.getName(): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
diff --git a/docs/dev.micheleferretti.mapboxpluginoffline.utils/index.md b/docs/dev.micheleferretti.mapboxpluginoffline.utils/index.md
@@ -13,4 +13,5 @@
 | Name | Summary |
 |---|---|
 | [android.os.Bundle](android.os.-bundle/index.md) |  |
+| [com.mapbox.mapboxsdk.offline.OfflineRegion](com.mapbox.mapboxsdk.offline.-offline-region/index.md) |  |
 | [com.mapbox.mapboxsdk.offline.OfflineRegionDefinition](com.mapbox.mapboxsdk.offline.-offline-region-definition/index.md) |  |
diff --git a/docs/package-list b/docs/package-list
@@ -1,7 +1,9 @@
 $dokka.format:gfm
 $dokka.linkExtension:md
+$dokka.location:dev.micheleferretti.mapboxpluginoffline.utils$convertToString(com.mapbox.mapboxsdk.offline.OfflineRegion)dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/convert-to-string.md
 $dokka.location:dev.micheleferretti.mapboxpluginoffline.utils$convertToString(com.mapbox.mapboxsdk.offline.OfflineRegionDefinition)dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/convert-to-string.md
 $dokka.location:dev.micheleferretti.mapboxpluginoffline.utils$getCameraPosition(com.mapbox.mapboxsdk.offline.OfflineRegionDefinition)dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/get-camera-position.md
+$dokka.location:dev.micheleferretti.mapboxpluginoffline.utils$getName(com.mapbox.mapboxsdk.offline.OfflineRegion)dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region/get-name.md
 $dokka.location:dev.micheleferretti.mapboxpluginoffline.utils$requireLong(android.os.Bundle, kotlin.String)dev.micheleferretti.mapboxpluginoffline.utils/android.os.-bundle/require-long.md
 dev.micheleferretti.mapboxpluginoffline
 dev.micheleferretti.mapboxpluginoffline.model
diff --git a/mapboxpluginoffline/build.gradle b/mapboxpluginoffline/build.gradle
@@ -16,7 +16,7 @@ android {
         minSdkVersion 14
         targetSdkVersion 29
         versionCode 1
-        versionName '2.0.13'
+        versionName '2.1.0'
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         archivesBaseName = "$archivesBaseName-$versionName"
     }
diff --git a/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/OfflineService.kt b/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/OfflineService.kt
@@ -96,8 +96,8 @@ class OfflineService : Service() {
                     options.metadata ?: byteArrayOf(),
                     object : OfflineManager.CreateOfflineRegionCallback {
                         override fun onCreate(offlineRegion: OfflineRegion?) {
-                            if (offlineRegion != null) startJob(OfflineDownloadJob(applicationContext, options, offlineRegion))
-                            else OfflineDownloadReceiver.dispatchCreateError(applicationContext, options, "OfflineRegion is null")
+                            if (offlineRegion == null) onError("offlineRegion is null")
+                            else startJob(OfflineDownloadJob(applicationContext, options, offlineRegion))
                         }
 
                         override fun onError(error: String?) {
@@ -106,21 +106,22 @@ class OfflineService : Service() {
                     }
                 )
             }
-            ACTION_CANCEL -> intent.extras?.requireLong(EXTRA_REGION_ID)?.also {
-                val job = jobs[it]
+            ACTION_CANCEL -> {
+                val regionId = requireNotNull(intent.extras).requireLong(EXTRA_REGION_ID)
+                val job = jobs[regionId]
                 if (job != null) {
                     notificationManager.notify(job.region.id.toInt(), job.getNotificationCancel())
                     job.region.setDownloadState(OfflineRegion.STATE_INACTIVE)
                     job.region.setObserver(null)
                     job.region.delete(object : OfflineRegion.OfflineRegionDeleteCallback {
                         override fun onDelete() {
                             OfflineDownloadReceiver.dispatchDelete(applicationContext, job.download)
-                            finishJob(it)
+                            finishJob(regionId)
                         }
 
                         override fun onError(error: String?) {
                             OfflineDownloadReceiver.dispatchDeleteError(applicationContext, job.download, error)
-                            finishJob(it)
+                            finishJob(regionId)
                         }
                     })
                 }
@@ -177,10 +178,11 @@ class OfflineService : Service() {
         startForeground(job.region.id.toInt(), job.getNotificationDownload())
     }
 
-    private fun finishJob(id: Long) {
-        val job = jobs.remove(id)
+    @Synchronized
+    private fun finishJob(regionId: Long) {
+        val job = jobs.remove(regionId)
         if (job != null) {
-            notificationManager.cancel(id.toInt())
+            notificationManager.cancel(regionId.toInt())
             job.cancelSnapshotter()
         }
         if (jobs.isEmpty()) {
diff --git a/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt b/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/utils/Extensions.kt
@@ -2,6 +2,7 @@ package dev.micheleferretti.mapboxpluginoffline.utils
 
 import android.os.Bundle
 import com.mapbox.mapboxsdk.camera.CameraPosition
+import com.mapbox.mapboxsdk.offline.OfflineRegion
 import com.mapbox.mapboxsdk.offline.OfflineRegionDefinition
 
 /**
@@ -13,6 +14,23 @@ import com.mapbox.mapboxsdk.offline.OfflineRegionDefinition
  */
 fun Bundle.requireLong(key: String): Long = this.get(key) as Long
 
+/**
+ * Returns a `String` representation of this object.
+ * @return a `String` representation of this object.
+ */
+fun OfflineRegion.convertToString() = "OfflineRegion(" +
+        "id=$id, " +
+        "name=${getName()}, " +
+        "definition=${definition.convertToString()}, " +
+        "isDeliveringInactiveMessages=$isDeliveringInactiveMessages" +
+        ")"
+
+/**
+ * Returns the region name converting `metadata` with [OfflineUtils.convertRegionName].
+ * @return the region name converting `metadata` with [OfflineUtils.convertRegionName].
+ */
+fun OfflineRegion.getName() = OfflineUtils.convertRegionName(metadata)
+
 /**
  * Returns a `String` representation of this object.
  * @return a `String` representation of this object.
