Refactor task list management into DmfsTaskListStore

Author: rfc2822

lib/src/main/kotlin/at/bitfire/ical4android/DmfsTaskList.kt

@@ -23,7 +23,6 @@ import java.util.LinkedList
 import java.util.logging.Level
 import java.util.logging.Logger
 
-
 /**
  * Represents a locally stored task list, containing [DmfsTask]s (tasks).
  * Communicates with tasks.org-compatible content providers (currently tasks.org and OpenTasks) to store the tasks.
@@ -36,80 +35,15 @@ abstract class DmfsTaskList<out T : DmfsTask>(
     val id: Long
 ) {
 
-    companion object {
-
-        private val logger
-            get() = Logger.getLogger(DmfsTaskList::class.java.name)
-
-        fun create(account: Account, provider: ContentProviderClient, providerName: TaskProvider.ProviderName, info: ContentValues): Uri {
-            info.put(TaskContract.ACCOUNT_NAME, account.name)
-            info.put(TaskContract.ACCOUNT_TYPE, account.type)
-
-            val url = TaskLists.getContentUri(providerName.authority).asSyncAdapter(account)
-            logger.log(Level.FINE, "Creating ${providerName.authority} task list", info)
-            return provider.insert(url, info)
-                ?: throw CalendarStorageException("Couldn't create task list (empty result from provider)")
-        }
-
-        fun <T : DmfsTaskList<DmfsTask>> findByID(
-            account: Account,
-            provider: ContentProviderClient,
-            providerName: TaskProvider.ProviderName,
-            factory: DmfsTaskListFactory<T>,
-            id: Long
-        ): T {
-            provider.query(
-                ContentUris.withAppendedId(TaskLists.getContentUri(providerName.authority), id).asSyncAdapter(account),
-                null,
-                null,
-                null,
-                null
-            )?.use { cursor ->
-                if (cursor.moveToNext()) {
-                    val taskList = factory.newInstance(account, provider, providerName, id)
-                    taskList.populate(cursor.toValues())
-                    return taskList
-                }
-            }
-            throw FileNotFoundException()
-        }
-
-        fun <T : DmfsTaskList<DmfsTask>> find(
-            account: Account,
-            factory: DmfsTaskListFactory<T>,
-            provider: ContentProviderClient,
-            providerName: TaskProvider.ProviderName,
-            where: String?,
-            whereArgs: Array<String>?
-        ): List<T> {
-            val taskLists = LinkedList<T>()
-            provider.query(
-                TaskLists.getContentUri(providerName.authority).asSyncAdapter(account),
-                null,
-                where,
-                whereArgs,
-                null
-            )?.use { cursor ->
-                while (cursor.moveToNext()) {
-                    val values = cursor.toValues()
-                    val taskList =
-                        factory.newInstance(account, provider, providerName, values.getAsLong(TaskLists._ID))
-                    taskList.populate(values)
-                    taskLists += taskList
-                }
-            }
-            return taskLists
-        }
-
-    }
+    private val logger
+        get() = Logger.getLogger(DmfsTaskList::class.java.name)
 
     var syncId: String? = null
     var name: String? = null
     var color: Int? = null
     var isSynced = false
     var isVisible = false
 
-
     /**
      * Sets the task list properties ([syncId], [name] etc.) from the passed argument,
      * which is usually directly taken from the tasks provider.
@@ -120,7 +54,7 @@ abstract class DmfsTaskList<out T : DmfsTask>(
      * @param values  values from tasks provider
      */
     @CallSuper
-    protected open fun populate(values: ContentValues) {
+    internal open fun populate(values: ContentValues) {
         syncId = values.getAsString(TaskLists._SYNC_ID)
         name = values.getAsString(TaskLists.LIST_NAME)
         color = values.getAsInteger(TaskLists.LIST_COLOR)

lib/src/main/kotlin/at/bitfire/ical4android/DmfsTaskListStore.kt

@@ -0,0 +1,81 @@
+/*
+ * This file is part of ical4android which is released under GPLv3.
+ * Copyright © All Contributors. See the LICENSE and AUTHOR files in the root directory for details.
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package at.bitfire.ical4android
+
+import android.accounts.Account
+import android.content.ContentProviderClient
+import android.content.ContentUris
+import android.content.ContentValues
+import android.net.Uri
+import at.bitfire.ical4android.util.MiscUtils.asSyncAdapter
+import at.bitfire.ical4android.util.MiscUtils.toValues
+import org.dmfs.tasks.contract.TaskContract
+import org.dmfs.tasks.contract.TaskContract.TaskLists
+import java.io.FileNotFoundException
+import java.util.LinkedList
+import java.util.logging.Level
+import java.util.logging.Logger
+
+class DmfsTaskListStore<TaskList: DmfsTaskList<Task>, Task: DmfsTask>(
+    private val account: Account,
+    private val providerName: TaskProvider.ProviderName,
+    private val provider: ContentProviderClient,
+    private val taskListFactory: DmfsTaskListFactory<TaskList>
+) {
+
+    private val logger
+        get() = Logger.getLogger(javaClass.name)
+
+    fun create(info: ContentValues): Uri {
+        info.put(TaskContract.ACCOUNT_NAME, account.name)
+        info.put(TaskContract.ACCOUNT_TYPE, account.type)
+
+        logger.log(Level.FINE, "Creating ${providerName.authority} task list", info)
+        val uri = TaskLists.getContentUri(providerName.authority).asSyncAdapter(account)
+        return provider.insert(uri, info)
+            ?: throw CalendarStorageException("Couldn't create task list (empty result from provider)")
+    }
+
+    fun getById(id: Long): TaskList {
+        provider.query(
+            /* url = */ ContentUris.withAppendedId(TaskLists.getContentUri(providerName.authority), id).asSyncAdapter(account),
+            /* projection = */ null,
+            /* selection = */ null,
+            /* selectionArgs = */ null,
+            /* sortOrder = */ null
+        )?.use { cursor ->
+            if (cursor.moveToNext()) {
+                val taskList = taskListFactory.newInstance(account, provider, providerName, id)
+                taskList.populate(cursor.toValues())
+                return taskList
+            }
+        }
+
+        // no task list found
+        throw FileNotFoundException()
+    }
+
+    fun find(where: String?, whereArgs: Array<String>?): List<TaskList> {
+        val taskLists = LinkedList<TaskList>()
+        provider.query(
+            /* url = */ TaskLists.getContentUri(providerName.authority).asSyncAdapter(account),
+            /* projection = */ null,
+            /* selection = */ where,
+            /* selectionArgs = */ whereArgs,
+            /* sortOrder = */ null
+        )?.use { cursor ->
+            while (cursor.moveToNext()) {
+                val values = cursor.toValues()
+                val taskList = taskListFactory.newInstance(account, provider, providerName, values.getAsLong(TaskLists._ID))
+                taskList.populate(values)
+                taskLists += taskList
+            }
+        }
+        return taskLists
+    }
+
+}