jarno/element-android
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

adding javadoc to the data store provider

Browse source
This commit is contained in:
Adam Brown 2022-02-02 15:47:30 +00:00
parent 3212bc2266
commit 0db38567ed
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
vector/src/main/java/im/vector/app/core/datastore/DataStoreProvider.kt
View file

@ -28,6 +28,13 @@ import kotlin.reflect.KProperty
/**
* Provides a singleton datastore cache
* allows for lazily fetching a datastore instance by key to avoid creating multiple stores for the same file
* Based on https://androidx.tech/artifacts/datastore/datastore-preferences/1.0.0-source/androidx/datastore/preferences/PreferenceDataStoreDelegate.kt.html
*
* Makes use of a ReadOnlyProperty in order to provide a simplified api on top of a Context
* ReadOnlyProperty allows us to lazily access the backing property instead of requiring it upfront as a dependency
* <pre>
* val Context.dataStoreProvider by dataStoreProvider()
* </pre>
*/
fun dataStoreProvider(): ReadOnlyProperty<Context, (String) -> DataStore<Preferences>> {
return MappedPreferenceDataStoreSingletonDelegate()