{"id":13428880,"url":"https://github.com/MarcinMoskala/PreferenceHolder","last_synced_at":"2025-03-16T02:30:39.598Z","repository":{"id":83821666,"uuid":"84814989","full_name":"MarcinMoskala/PreferenceHolder","owner":"MarcinMoskala","description":"SharedPreference usage made fun in Kotlin","archived":false,"fork":false,"pushed_at":"2018-08-27T13:35:03.000Z","size":242,"stargazers_count":155,"open_issues_count":6,"forks_count":22,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T15:01:19.102Z","etag":null,"topics":["gradle","kotlin","kotlin-android","preferences"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MarcinMoskala.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-03-13T10:42:22.000Z","updated_at":"2024-03-22T02:16:09.000Z","dependencies_parsed_at":"2024-01-07T04:47:56.464Z","dependency_job_id":null,"html_url":"https://github.com/MarcinMoskala/PreferenceHolder","commit_stats":null,"previous_names":["marcinmoskala/kotlinpreferencesobject"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcinMoskala%2FPreferenceHolder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcinMoskala%2FPreferenceHolder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcinMoskala%2FPreferenceHolder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcinMoskala%2FPreferenceHolder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MarcinMoskala","download_url":"https://codeload.github.com/MarcinMoskala/PreferenceHolder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243815603,"owners_count":20352195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gradle","kotlin","kotlin-android","preferences"],"created_at":"2024-07-31T01:01:07.649Z","updated_at":"2025-03-16T02:30:39.200Z","avatar_url":"https://github.com/MarcinMoskala.png","language":"Kotlin","funding_links":[],"categories":["Libraries","\u003ca name=\"utility\"\u003e\u003c/a\u003eUtility \u003csup\u003e[Back ⇈](#contents)\u003c/sup\u003e","Kotlin"],"sub_categories":[],"readme":"# PreferenceHolder\nKotlin Android Library, that makes preference usage simple and fun.\n\n[![](https://jitpack.io/v/com.MarcinMoskala/PreferenceHolder.svg)](https://jitpack.io/#com.MarcinMoskala/PreferenceHolder)[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)\n[![Build Status](https://travis-ci.org/MarcinMoskala/PreferenceHolder.svg?branch=master)](https://travis-ci.org/MarcinMoskala/PreferenceHolder)\n[![codebeat badge](https://codebeat.co/badges/035647e2-1a10-48b8-80ae-e6a02c5c0ded)](https://codebeat.co/projects/github-com-marcinmoskala-preferenceholder-master)\n[![Analytics](https://ga-beacon.appspot.com/UA-92159206-8/main-page?pixel)](https://github.com/MarcinMoskala/PreferenceHolder)\n[![Analytics](https://ga-beacon.appspot.com/UA-92159206-7/main-page?pixel)](https://github.com/MarcinMoskala/PreferenceHolder)\n\nTo stay up-to-date with news about library [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social\u0026label=Follow%20%40marcinmoskala)](https://twitter.com/marcinmoskala?ref_src=twsrc%5Etfw)\n\nThis library is younger brother of [KotlinPreferences](https://github.com/MarcinMoskala/KotlinPreferences).\n\nWith PreferenceHolder, you can define different preference fields this way:\n\n```kotlin\nobject Pref: PreferenceHolder() {\n    var canEatPie: Boolean by bindToPreferenceField(true)\n}\n```\n\nAnd use it this way:\n\n```kotlin\nif(Pref.canEatPie) //...\n```\n\nHere are other preference definition examples: (see [full example](https://github.com/MarcinMoskala/PreferenceHolder/blob/master/kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/ExampleConfig.kt) and [usage](https://github.com/MarcinMoskala/PreferenceHolder/tree/master/kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences))\n\n```kotlin\nobject UserPref: PreferenceHolder() {\n    var canEatPie: Boolean by bindToPreferenceField(true)\n    var allPieInTheWorld: Long by bindToPreferenceField(0)\n\n    var isMonsterKiller: Boolean? by bindToPreferenceFieldNullable()\n    var monstersKilled: Int? by bindToPreferenceFieldNullable()\n    \n    // Property with backup is reading stored value in the first usage, \n    // and saving it, in background, each time it is changed.\n    var experience: Float? by bindToPropertyWithBackup(-1.0F) \n    var className: String? by bindToPropertyWithBackupNullable()\n\n    // Any type can used if serializer is set. See: Gson serialization\n    var character: Character? by bindToPreferenceFieldNullable()\n    var savedGame: Game? by bindToPreferenceFieldNullable()\n\n    // Single level collections are also supported if serializer is set. See: Gson serialization\n    var longList: Map\u003cInt, Long\u003e by bindToPreferenceField(mapOf(0 to 12L, 10 to 143L))\n    var propTest: List\u003cCharacter\u003e? by bindToPropertyWithBackupNullable()\n    var elemTest: Set\u003cElems\u003e by bindToPreferenceField(setOf(Elems.Elem1, Elems.Elem3))\n}\n```\n\nThere must be application Context added to PreferenceHolder companion object. Example:\n\n```kotlin\nclass App : Application() {\n\n    override fun onCreate() {\n        super.onCreate()\n        PreferenceHolder.setContext(applicationContext)\n    }\n}\n```\n\nIt it suggested to do it in project Application class. As an alternative, PreferenceHolderApplication can also be added as a name of an application in AndroidManifest: ([example](https://github.com/MarcinMoskala/PreferenceHolder/blob/master/sample/src/main/AndroidManifest.xml#L12))\n\n```\nandroid:name=\"com.marcinmoskala.kotlinpreferences.PreferenceHolderApplication\"\n```\n\n## Unit testing components\n\nLibrary also include test mode:\n\n```\nPreferenceHolder.testingMode = true\n```\n\nWhen 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 to use cases that are using instance of PreferenceHolder.\n\n## Install\n\nTo add PreferenceHolder to the project, add to build.gradle file:\n\n```groovy\ndependencies {\n    compile \"com.marcinmoskala.PreferenceHolder:preferenceholder:1.51\"\n}\n```\n\nWhile library is located on JitPack, remember to add to module build.gradle (unless you already have it):\n\n```groovy\nrepositories {\n    maven { url 'https://jitpack.io' }\n}\n```\n\n## Gson serialization\n\nTo use Gson serializer, we need to add following dependency:\n\n```groovy\ndependencies {\n    compile \"com.marcinmoskala.PreferenceHolder:preferenceholder-gson-serializer:1.51\"\n}\n```\n\nAnd specify `GsonSerializer` as `PreferenceHolder` serializer: \n\n```kotlin\nPreferenceHolder.serializer = GsonSerializer(Gson())\n```\n\nSince then, we can use all types, even one not supported by SharedPreference (like custom objects `Character` and `Game`, or collections)\n\n## Other libraries\n\nIf you like it, remember to leave the star and check out my other libraries:\n * [ActivityStarter](https://github.com/MarcinMoskala/ActivityStarter/blob/master/README.md) - Simple Android Library, that provides easy way to start and save state of Activities, Fragments, Services and Receivers with arguments.\n * [ArcSeekBar](https://github.com/MarcinMoskala/ArcSeekBar) - Good looking curved Android SeekBar\n * [VideoPlayView](https://github.com/MarcinMoskala/VideoPlayView) - Custom Android view with video player, loader and placeholder image\n * [KotlinAndroidViewBindings](https://github.com/MarcinMoskala/KotlinAndroidViewBindings) - Bindings for properties with simple Kotlin types (Boolean, String) to layout traits (visibility, text).\n\nLicense\n-------\n\n    Copyright 2017 Marcin Moskała\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMarcinMoskala%2FPreferenceHolder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMarcinMoskala%2FPreferenceHolder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMarcinMoskala%2FPreferenceHolder/lists"}