JadeSharedPreference
A light weight library which uses annotation processing to generate codes that let you read and write to SharedPreferences file.
- Eliminate the whole
SharedPreferenceboilerplace codes - Write less code to configure JadeSharedPreference
- Save multiple values to
SharedPreferencesat onces - Read from
SharedPreferencesusing just annotations@Read...) - Listen to value changes in real-time
- Read/Write
Preferencedata anywhere in your app
No one like writing lot of codes just to do a simple task. I mean, who does this:
val sp: SharedPreference = getSharedPreferences("coconut_head", Context.MODE_PRIVATE)
val value: String? =sp.getString("key", null)
When you can achieve same thing with less line of codes. Such as this:
@ReadString("key")
val value: String?= null
What's new in version 1.3.0
- Bug fixes
- Support for
Preferencefile
Usage
class InecBox @SharedPref("key") @Preference constructor(context: Context) {
val TAG: String = "InecBox"
@ReadString("ballot")
var ballotPaper: String? = null
@ReadPrefString("pref_ballot")
var fakeBallot: String? = null
//Setup for SharedPreference file
private var jsp :JadeSharedPreference =JadeSharedPreference.apply(this, context)
//Setup for Preference file
private var jp :JadeSharedPreference =JadeSharedPreference.preference(this, context)
fun inecBox() {
jsp.insert("ballot", "Ballot Paper")
}
fun readBallot(){
Log.d(TAG, ballotPaper)
}
fun fakeInecBox() {
jp.insert("pref_ballot", "Fake Ballot Paper")
}
fun readFakeBallot(){
Log.d(TAG, fakeBallot)
}
}
Check the sample project to see more sample usages.
Configuration
Step 1: Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Step 2: Add the dependency
dependencies {
implementation 'com.github.devmike01.JadeSharedPreference:binder:1.3.0'
kapt 'com.github.devmike01.JadeSharedPreference:compiler:1.3.0'
}
Note: Add
apply plugin: 'kotlin-kapt'- if you don't already have it, to your appbuild.gradleto allow the the processor generates the necessary codes.
License
Copyright 2018 Oladipupo Gbenga
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.
6 Nov 23, 2021
14 Dec 26, 2022
9 Jun 20, 2021
201 Dec 9, 2022
68 Jan 6, 2023
0 Dec 3, 2021
6 May 22, 2022
468 Jan 4, 2023
25 Aug 18, 2022
63 Oct 3, 2022
1 Oct 28, 2021
13 Apr 4, 2020
112 Dec 9, 2022
19 Dec 16, 2020
514 Jan 8, 2023
73 Nov 28, 2022
25 Dec 27, 2022
50 Nov 6, 2022
684 Dec 22, 2022