Android Shared Preferences

A simple easy to use library that helps you quickly store and retrive data from shared preferences

Supporting Android Easy Preferences

Android Easy Preferences is an independent project with ongoing development and support made possible thanks to donations made by these awesome backers. If you'd like to join them, please consider:

• Become a backer or sponsor on Patreon.
• One-time donation via PayPal

How to integrate into your app

Integrating the library into you app is extremely easy. A few changes in the build gradle and your all ready to use TinyDB. Make the following changes.

Step 1. Add the JitPack repository to your build file. 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.mukeshsolanki:easypreferences:<latest-version>'
}

How to use the library

Okay seems like you integrated the library in your project but how do you use it? Well its really easy just follow the steps below.

 //Create a new instance of EasyPreferences
 val prefs = EasyPreferences.defaultPrefs(this)

 //use that instance to save data
 prefs["TestKey"] = "HelloWorld"; //Save's a string value in your preferences
 prefs["Key2"] = 1; //Save's a int value in your preferences

 //use that instance to retrieve data
 val value: String? = prefs["TestKey"]; //retrives the data from preferences
 val defaultVal: Int? = prefs["Key2", 100] //retrives the data from preferences or default values if it does not exists

That's pretty much it. Looks like your all done here.

Author

Maintained by Mukesh Solanki

Contribution

• Bug reports and pull requests are welcome.
• Make sure you use square/java-code-styles to format your code.

License

MIT License

Copyright (c) 2018 Mukesh Solanki

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.