Code Monkey home page Code Monkey logo

settings's Introduction

Settings

Build CodeFactor Maven Central

Settings is a simple wrapper with type safety for SharedPreferences and Datastore. By using it, you will no longer need to use Strings as keys. Instead, each Preference is represented by an object.

โš ๏ธ Settings Datastore will now be published from
https://github.com/ch4rl3x/settings-multiplatform

Features

  • Type safety for SharedPreferences
  • Simple usage for SharedPrefernces
  • Encryption

Dependency

Add the library to your module build.gradle

dependencies {
    implementation 'de.charlex.settings:settings-sharedpreferences:<version>'
    implementation 'de.charlex.settings:settings-sharedpreferences-encryption:<version>'
}

Usage

Declaring Preferences

enum class ExampleEnumWithKey(val preferenceKey: String) {
    Value1("value1_key"),
    Value2("value2_key"),
    Value3("value3_key")
}

enum class SimpleEnum {
    Value1,
    Value2,
    Value3
}
object Preferences {
    val preferenceInt = intPreference("preference_int", 1)
    val preferenceString = stringPreference("preference_string", "default")
    val preferenceFloat = floatPreference("preference_float", 1.1f)
    val preferenceLong = longPreference("preference_long", 1L)
    val preferenceBoolean = boolenPreference("preference_boolean", true)

    // enum preferences have to specify which function to use for retrieving the key
    val preferenceExampleEnumWithKey = enumPreference("preference_enum_with_key", ExampleEnumWithKey.Value2, ExampleEnumWithKey::preferenceKey)
    val preferenceExampleEnumWithOrdinal = enumPreference("preference_enum_with_ordinal", SimpleEnum.Value2, SimpleEnum::ordinal)
    val preferenceExampleEnumWithName = enumPreference("preference_enum_with_name", SimpleEnum.Value2, SimpleEnum::name)

    val preferenceStringEncrypted = encryptedStringPreference("preference_string_encrypted", "default")
}

Using Preferences

val settings = Settings.create(context)
val encryptedSettings = Settings.createEncrypted(context)

//Read
val exampleString: String = settings.get(Preferences.PreferenceString)
val exampleEnumWithKey: ExampleEnumWithKey = settings.get(Preferences.preferenceExampleEnumWithKey)

val encryptedExampleString: String = encryptedSettings.get(Preferences.preferenceStringEncrypted)

//Write
settings.put(Preferences.preferenceString, "my value")
settings.put(Preferences.preferenceExampleEnumWithKey, ExampleEnumWithKey.Value1)
settings.put(Preferences.preferenceExampleEnumWithOrdinal, SimpleEnum.Value1)

encryptedSettings.put(Preferences.preferenceStringEncrypted, "my secrets")

That's it!

License

Copyright 2020 Alexander Karkossa

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.

settings's People

Contributors

ch4rl3x avatar dependabot[bot] avatar kalinjul avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.