KDoc, shouldBeReadOnly

bitfireAT · Nov 12, 2024 · 72aef60 · 72aef60
1 parent 8cbfe1d
commit 72aef60
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/app/src/main/kotlin/at/bitfire/davdroid/resource/LocalAddressBook.kt b/app/src/main/kotlin/at/bitfire/davdroid/resource/LocalAddressBook.kt
@@ -103,6 +103,18 @@ open class LocalAddressBook @AssistedInject constructor(
                 ?: throw IllegalStateException("Address book has no URL")
         set(url) = AccountManager.get(context).setAndVerifyUserData(addressBookAccount, USER_DATA_URL, url)
 
+    /**
+     * Read-only flag for the address book itself.
+     *
+     * Setting this flag:
+     *
+     * - stores the new value in [USER_DATA_READ_ONLY] and
+     * - sets the read-only flag for all contacts and groups in the address book in the content provider, which will
+     * prevent non-sync-adapter apps from modifying them. However new entries can still be created, so the address book
+     * is not really read-only.
+     *
+     * Reading this flag returns the stored value from [USER_DATA_READ_ONLY].
+     */
     override var readOnly: Boolean
         get() = AccountManager.get(context).getUserData(addressBookAccount, USER_DATA_READ_ONLY) != null
         set(readOnly) {

diff --git a/app/src/main/kotlin/at/bitfire/davdroid/resource/LocalAddressBookStore.kt b/app/src/main/kotlin/at/bitfire/davdroid/resource/LocalAddressBookStore.kt
@@ -87,7 +87,7 @@ class LocalAddressBookStore @Inject constructor(
         // update settings
         addressBook.updateSyncFrameworkSettings()
         addressBook.settings = contactsProviderSettings
-        addressBook.readOnly = forceAllReadOnly || fromCollection.readOnly()
+        addressBook.readOnly = shouldBeReadOnly(fromCollection, forceAllReadOnly)
 
         return addressBook
     }
@@ -163,7 +163,6 @@ class LocalAddressBookStore @Inject constructor(
             localCollection.readOnly = nowReadOnly
         }
 
-
         // make sure it will still be synchronized when contacts are updated
         localCollection.updateSyncFrameworkSettings()
     }

diff --git a/app/src/main/kotlin/at/bitfire/davdroid/resource/LocalDataStore.kt b/app/src/main/kotlin/at/bitfire/davdroid/resource/LocalDataStore.kt
@@ -24,6 +24,14 @@ interface LocalDataStore<T: LocalCollection<*>> {
      */
     fun create(provider: ContentProviderClient, fromCollection: Collection): T?
 
+    /**
+     * Returns all local collections of the data store.
+     *
+     * @param account  the account that the data store is associated with
+     * @param provider the content provider client
+     *
+     * @return a list of all local collections
+     */
     fun getAll(account: Account, provider: ContentProviderClient): List<T>
 
     /**