Skip to content
A Kotlin library that makes Android SharedPreferences easier to use
Kotlin
Branch: master
Clone or download
Latest commit a8b24e4 Apr 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
koap-gson-serializer
koap
sample
.codebeatignore
.gitignore
.travis.yml
LICENSE.txt
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

Koap

License JitPack API Build Status codebeat badge Android Arsenal

A Kotlin library that makes Android SharedPreferences easier to use.
You can use it as if you are using a typical data class.

Usage

Note that this library doesn't allow nullable property except ReadWriteSerializable delegator

  • Basics
    Create a SharedPreferences instance and then pass it on to the parameter of the bind function
object AccountPreference : PreferenceHolder(name = "account") {
    var id: String by ReadWriteString()
    var name: String by ReadWriteString(default = "leopold")
    var age: Int by ReadWriteInt(caching = false)
    var token: String by ReadWriteString(key = "pref_token")
}

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        Koap.bind(this, AccountPreference)
    }
}

if (AccountPreference.id.isEmpty()) {

}


if (AccountPreference.age > 30) {

}
  • Using predicate
object AccountPreference : PreferenceHolder(name = "account", cacheStrategy = CacheStrategy.LAZY) {
    var id: String by ReadWriteString(predicate = { it.isNotEmpty() })
    var name: String by ReadWriteString(caching = false, predicate = { it.length > 2 && it.startsWith("leo")} )
    var age: Int by ReadWriteInt(predicate = { it > 0 })
    var token: String by ReadWriteString(predicate = { it.length > 10 })
    var imageUrl: String by ReadWriteString(predicate = { it.startsWith("http")} )
    var account: Account? by ReadWriteSerializable(type = inferType<Account>(), predicate = { it?.age ?: 0 > 30 })
}

data class Account(
    val id: String,
    val nick: String,
    val age: Int
)
  • Cache Strategy
object AccountPreference : PreferenceHolder(name = "account", cacheStrategy = CacheStrategy.EAGER) {
    var id: String by ReadWriteString()
}

// Default cacheStrategy is CacheStrategy.LAZY
  • File creation mode
object AccountPreference : PreferenceHolder(name = "account", mode = Context.MODE_PRIVATE) {
    var id: String by ReadWriteString()
}

// Default mode is Context.MODE_PRIVATE
  • Default SharedPreferences
object AccountPreference : PreferenceHolder(name = "", default = true) {
    var id: String by ReadWriteString()
}

Testing

Just turn on the test mode.

Koap.isTestMode = true

When it is turned on, then all properties are acting just like normal properties.

Importing the Library

Add jitpack.io to your project's repositories:

repositories {
    maven { url 'https://jitpack.io' }
}

Add the following dependency to your build.gradle file to use the latest version:

implementation 'com.github.AgustaRC.koap:koap:1.0.1'

Gson serialization

To use Gson serializer, we need to add following dependency:

implementation "com.github.AgustaRC.koap:koap-gson-serializer:1.0.1"

And specify GsonSerializer as Koap serializer:

Koap.serializer = GsonSerializer(Gson())

Since then, we can use all types, even one not supported by SharedPreference

Contributing to the Project

If you'd like to contribute code to this project you can do so through GitHub by forking the repository and generating a pull request.

By contributing your code, you agree to license your contribution under the terms of the Apache License v2.0.

Developed By

Reference

License

Copyright 2019 Leopold Baik

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.
You can’t perform that action at this time.