ConfigurNation

Annotation based Kotlin Interfaces for Android SharedPreferences

Programming language: Java

License: Apache License 2.0

Tags: Kotlin     Android     Java     Android-library     Shared Preferences    

Latest version: v0.9

README

ConfigurNation

Annotation based Kotlin Interfaces for Android SharedPreferences

Installation

Gradle

Dependencies

implementation 'com.izikode.izilib:configurnation:0.9'
kapt 'com.izikode.izilib:configurnation-compiler:0.9'

Source sets

ConfigurNation generates Kotlin source files, so you need to include the generation folder into your source sets.

android {
   ...
   sourceSets {
        main {
            java {
                srcDir "${buildDir.absolutePath}/generated/source/kaptKotlin/"
            }
        }
    }
}

Usage

#1 SETUP your mapping interface

@ConfigurNation( name = "SampleAppConfig", mode = Context.MODE_PRIVATE )
interface ConfigMap { ... }

• Create your mapping interface and decorate with @ConfigurNation.
  • The name variable is the name of the generated Config class.
  • The mode variable is the mode assigned to the inner SharedPreferences object.
  • The mapping interface can be named anything, the qualified name of the class will be used as the SharedPreferences identifier. kotlin @ConfigurMember fun aBool(): Boolean
• Declare abstract functions inside your interface, for your Config fields.
  • Decorate the config fields with @ConfigurMember
  • The name of the function is the name of the field inside the Config class.
  • The return type of the function is the type of data that will be stored.
    • Only valid SharePreferences types are supported at the moment. Those are:
      • Boolean
      • Float
      • Integer
      • Long
      • String

#2 BUILD your project

#3 USE

val config = SampleAppConfig(context)

/* write */
config.aBool = true

/* read */
val value = config.aBool

#4 MEMBER PARAMS

The ConfigurMember annotation has two parameters for more complex functions. The type controls how the data of the member are retrieved and stored and supports Synchronous, Asynchronous and Mixed modes. The withVariants flag controls whether a member has Key-based Variants under the same name or not.

For a full example of those parameters, see the Sample project.

Licence

Copyright 2018 Fanis Veizis

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.