Kotlin Android Library, that makes preference usage simple and fun.
This library younger brother of KotlinPreferences.
With PreferenceHolder, you can define different preference fields this way:
object Pref: PreferenceHolder() {
var canEatPie: Boolean by bindToPreferenceField(true)
}
And use it this way:
if(Pref.canEatPie) //...
Here are other preference definition examples: (see full example and usage)
object UserPref: PreferenceHolder() {
var canEatPie: Boolean by bindToPreferenceField(true)
var allPieInTheWorld: Long by bindToPreferenceField(0)
var isMonsterKiller: Boolean? by bindToPreferenceFieldNullable()
var monstersKilled: Int? by bindToPreferenceFieldNullable()
// Property with backup is reading stored value in the first usage,
// and saving it, in background, each time it is changed.
var experience: Float? by bindToPropertyWithBackup(-1.0F)
var className: String? by bindToPropertyWithBackupNullable()
// Each type, that can be serialized and deserialized using Gson,
// can be used as type of property binded to SharedPreference field.
var character: Character? by bindToPreferenceFieldNullable()
var savedGame: Game? by bindToPreferenceFieldNullable()
// Single level collections are also supported since 1.2
var longList: Map<Int, Long> by bindToPreferenceField(mapOf(0 to 12L, 10 to 143L))
var propTest: List<Character>? by bindToPropertyWithBackupNullable()
var elemTest: Set<Elems> by bindToPreferenceField(setOf(Elems.Elem1, Elems.Elem3))
}
There must be application Context added to PreferenceHolder companion object. Example:
class App : Application() {
override fun onCreate() {
super.onCreate()
PreferenceHolder.setContext(applicationContext)
}
}
It it suggested to do it in project Application class. As an alternative, there can also be added PreferenceHolderApplication as an name in application in AndroidManifest: (example)
android:name="com.marcinmoskala.kotlinpreferences.PreferenceHolderApplication"
Library also include test mode:
PreferenceHolder.testingMode = true
When it is turned on, then all properties are acting just like normal properties without binding to preference field. This allows to make unit tests to presenters and use cases that are using instance of PreferenceHolder.
To add PreferenceHolder to the project, add in build.gradle file:
dependencies {
compile 'com.github.marcinmoskala:PreferenceHolder:1.4'
}
And while library is located on JitPack, remember to add on module build.gradle (unless you already have it):
repositories {
maven { url 'https://jitpack.io' }
}
Copyright 2017 Marcin Moskała
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.