├── kotlinpreferences-lib ├── .gitignore ├── proguard-rules.pro ├── src │ ├── main │ │ ├── AndroidManifest.xml │ │ └── java │ │ │ └── com │ │ │ └── marcinmoskala │ │ │ └── kotlinpreferences │ │ │ ├── ContextExtension.kt │ │ │ ├── GsonHelpers.kt │ │ │ ├── bindings │ │ │ ├── PropertyWithBackup.kt │ │ │ ├── PreferenceFieldDelegate.kt │ │ │ ├── PropertyWithBackupNullable.kt │ │ │ ├── PutValueExt.kt │ │ │ └── PreferenceFieldDelegateNullable.kt │ │ │ └── KotlinPreferences.kt │ └── androidTest │ │ └── java │ │ └── com │ │ └── marcinmoskala │ │ └── kotlinpreferences │ │ ├── BaseTest.kt │ │ ├── TestUtills.kt │ │ ├── ObjectsTest.kt │ │ ├── PreferenceFieldTest.kt │ │ ├── PropertyWithBackupTest.kt │ │ ├── PreferenceFieldNullableTest.kt │ │ ├── PropertyWithBackupNullableTest.kt │ │ ├── SpeedComparationTest.kt │ │ └── ExampleConfig.kt └── build.gradle ├── settings.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── gradle.properties ├── .travis.yml ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE /kotlinpreferences-lib/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':kotlinpreferences-lib' 2 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MarcinMoskala/KotlinPreferences/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/workspace.xml 5 | /.idea/libraries 6 | .DS_Store 7 | /build 8 | /captures 9 | .externalNativeBuild 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Mon Dec 28 10:00:20 PST 2015 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip 7 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/BaseTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | open class BaseTest { 4 | 5 | val pref get() = android.support.test.InstrumentationRegistry.getTargetContext().preferences 6 | 7 | init { pref.clear() } 8 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/ContextExtension.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.content.Context 4 | import android.content.SharedPreferences 5 | import android.preference.PreferenceManager 6 | 7 | val Context.preferences: SharedPreferences 8 | get() = PreferenceManager.getDefaultSharedPreferences(this) 9 | 10 | fun SharedPreferences.clear() = edit().clear().apply() -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/TestUtills.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import org.junit.Assert 4 | import kotlin.reflect.KMutableProperty0 5 | 6 | fun testValues(property: KMutableProperty0, start: T?, vararg values: T) { 7 | Assert.assertEquals(start, property.get()) 8 | values.forEach { 9 | property.set(it) 10 | Assert.assertEquals(it, property.get()) 11 | } 12 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/GsonHelpers.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import com.google.gson.Gson 4 | import com.google.gson.GsonBuilder 5 | import com.google.gson.JsonSyntaxException 6 | import kotlin.reflect.KClass 7 | 8 | var preferencesGson: Gson = GsonBuilder().create() 9 | 10 | internal fun Any.toJson() = preferencesGson.toJson(this)!! 11 | 12 | internal fun String.fromJson(clazz: KClass) = try { 13 | preferencesGson.fromJson(this, clazz.java) 14 | } catch (e: Throwable) { 15 | throw Error("Error in parsing to ${clazz.java}. Possibly lack of gson serializers. The string to parse: \"$this\"", e) 16 | } -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | 3 | # IDE (e.g. Android Studio) users: 4 | # Gradle settings configured through the IDE *will override* 5 | # any settings specified in this file. 6 | 7 | # For more details on how to configure your build environment visit 8 | # http://www.gradle.org/docs/current/userguide/build_environment.html 9 | 10 | # Specifies the JVM arguments used for the daemon process. 11 | # The setting is particularly useful for tweaking memory settings. 12 | org.gradle.jvmargs=-Xmx1536m 13 | 14 | # When configured, Gradle will run in incubating parallel mode. 15 | # This option should only be used with decoupled projects. More details, visit 16 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 17 | # org.gradle.parallel=true 18 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: android 2 | 3 | android: 4 | components: 5 | - tools 6 | - platform-tools 7 | - build-tools-25.0.2 8 | - android-25 9 | - extra-android-m2repository 10 | - sys-img-armeabi-v7a-android-18 11 | 12 | jdk: 13 | - oraclejdk8 14 | 15 | sudo: true 16 | 17 | before_script: 18 | - echo no | android create avd --force -n test -t android-18 --abi armeabi-v7a 19 | - emulator -avd test -no-window & 20 | - android-wait-for-emulator 21 | - adb shell input keyevent 82 22 | 23 | env: 24 | matrix: 25 | - TEST=connectedDebugAndroidTest 26 | 27 | script: 28 | - ./gradlew $TEST -i 29 | 30 | branches: 31 | only: 32 | - master 33 | - stable 34 | 35 | notifications: 36 | email: true 37 | 38 | cache: 39 | directories: 40 | - $HOME/.m2 41 | - $HOME/.gradle -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/ObjectsTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Test 6 | import org.junit.runner.RunWith 7 | 8 | @RunWith(AndroidJUnit4::class) 9 | class ObjectsTest: BaseTest() { 10 | 11 | @Test 12 | fun characterTest() { 13 | val character1 = Character("Marcin", "Human", "Wizzard") 14 | val character2 = Character("Marcin", "SuperHuman", "Wizzard") 15 | testValues(pref::character, null, character1, character2) 16 | } 17 | 18 | @Test 19 | fun bigObjectTest() { 20 | val game1 = Game(Character("Marcin", "Human", "Wizzard"), GameMode.Hard, 100) 21 | testValues(pref::savedGame, null, game1) 22 | } 23 | } 24 | 25 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/bindings/PropertyWithBackup.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences.bindings 2 | 3 | import android.content.SharedPreferences 4 | import kotlin.concurrent.thread 5 | import kotlin.reflect.KClass 6 | import kotlin.reflect.KProperty 7 | 8 | internal class PropertyWithBackup(clazz: KClass, default: T?, key: String?) : PreferenceFieldDelegate(clazz, default, key) { 9 | 10 | var field: T? = null 11 | 12 | override operator fun getValue(thisRef: SharedPreferences, property: KProperty<*>): T = 13 | field ?: super.getValue(thisRef, property).apply { field = this } 14 | 15 | override fun setValue(thisRef: SharedPreferences, property: KProperty<*>, value: T) { 16 | if(value == field) return 17 | field = value 18 | thread { 19 | super.setValue(thisRef, property, value) 20 | } 21 | } 22 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/bindings/PreferenceFieldDelegate.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("UNCHECKED_CAST") 2 | 3 | package com.marcinmoskala.kotlinpreferences.bindings 4 | 5 | import android.content.SharedPreferences 6 | import kotlin.properties.ReadWriteProperty 7 | import kotlin.reflect.KClass 8 | import kotlin.reflect.KProperty 9 | 10 | internal open class PreferenceFieldDelegate( 11 | private val clazz: KClass, 12 | private val default: T?, 13 | private val key: String? 14 | ) : ReadWriteProperty { 15 | 16 | override operator fun getValue(thisRef: SharedPreferences, property: KProperty<*>): T 17 | = thisRef.getValue(clazz, default, getKey(property)) 18 | 19 | override fun setValue(thisRef: SharedPreferences, property: KProperty<*>, value: T) { 20 | thisRef.edit().apply { putValue(clazz, value, getKey(property)) }.apply() 21 | } 22 | 23 | private fun getKey(property: KProperty<*>) = key ?: "${property.name}Key" 24 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/PreferenceFieldTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Test 6 | import org.junit.runner.RunWith 7 | 8 | @RunWith(AndroidJUnit4::class) 9 | class PreferenceFieldTest: BaseTest() { 10 | 11 | @Test 12 | fun booleanDefaultChangeTest() { 13 | testValues(pref::canEatPie, true, false, true, false) 14 | } 15 | 16 | @Test 17 | fun intDefaultChangeTest() { 18 | testValues(pref::pieBaked, 5, 10, 0, 10, -19) 19 | } 20 | 21 | @Test 22 | fun longDefaultChangeTest() { 23 | testValues(pref::allPieInTheWorld, -1L, 10L, 0L, 100L) 24 | } 25 | 26 | @Test 27 | fun floatDefaultChangeTest() { 28 | testValues(pref::pieEaten, 0.0F, 10F, 0.06F, 100F) 29 | } 30 | 31 | @Test 32 | fun stringDefaultChangeTest() { 33 | testValues(pref::bestPieName, "Pie", "BlueberryPie", "SuperPie") 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/PropertyWithBackupTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Test 6 | import org.junit.runner.RunWith 7 | 8 | @RunWith(AndroidJUnit4::class) 9 | class PropertyWithBackupTest: BaseTest() { 10 | 11 | @Test 12 | fun booleanDefaultChangeTest() { 13 | testValues(pref::p_canEatPie, true, false, true, false) 14 | } 15 | 16 | @Test 17 | fun intDefaultChangeTest() { 18 | testValues(pref::p_pieBaked, 5, 10, 0, 10, -19) 19 | } 20 | 21 | @Test 22 | fun longDefaultChangeTest() { 23 | testValues(pref::p_allPieInTheWorld, -1L, 10L, 0L, 100L) 24 | } 25 | 26 | @Test 27 | fun floatDefaultChangeTest() { 28 | testValues(pref::p_pieEaten, 0.0F, 10F, 0.06F, 100F) 29 | } 30 | 31 | @Test 32 | fun stringDefaultChangeTest() { 33 | testValues(pref::p_bestPieName, "Pie", "BlueberryPie", "SuperPie") 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/PreferenceFieldNullableTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Test 6 | import org.junit.runner.RunWith 7 | 8 | @RunWith(AndroidJUnit4::class) 9 | class PreferenceFieldNullableTest: BaseTest() { 10 | 11 | @Test 12 | fun booleanDefaultChangeTest() { 13 | testValues(pref::isMonsterKiller, null, true, false, true, null) 14 | } 15 | 16 | @Test 17 | fun intDefaultChangeTest() { 18 | testValues(pref::monstersKilled, null, 10, 0, 10, -19) 19 | } 20 | 21 | @Test 22 | fun longDefaultChangeTest() { 23 | testValues(pref::numberOfHahaInLough, null, 10L, 0L, 100L) 24 | } 25 | 26 | @Test 27 | fun floatDefaultChangeTest() { 28 | testValues(pref::experience, null, 10F, 0F, 100F) 29 | } 30 | 31 | @Test 32 | fun stringDefaultChangeTest() { 33 | testValues(pref::className, null, "BlueberryPie", "SuperPie") 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/bindings/PropertyWithBackupNullable.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences.bindings 2 | 3 | import android.content.SharedPreferences 4 | import kotlin.concurrent.thread 5 | import kotlin.reflect.KClass 6 | import kotlin.reflect.KProperty 7 | 8 | internal class PropertyWithBackupNullable(clazz: KClass, key: String? = null) : PreferenceFieldDelegateNullable(clazz, key) { 9 | 10 | var propertySet: Boolean = false 11 | var field: T? = null 12 | 13 | override operator fun getValue(thisRef: SharedPreferences, property: KProperty<*>): T? = if (propertySet) field else { 14 | val newValue = super.getValue(thisRef, property) 15 | field = newValue 16 | propertySet = true 17 | newValue 18 | } 19 | 20 | override fun setValue(thisRef: SharedPreferences, property: KProperty<*>, value: T?) { 21 | propertySet = true 22 | if(value == field) return 23 | field = value 24 | thread { 25 | super.setValue(thisRef, property, value) 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/PropertyWithBackupNullableTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Test 6 | import org.junit.runner.RunWith 7 | 8 | @RunWith(AndroidJUnit4::class) 9 | class PropertyWithBackupNullableTest: BaseTest() { 10 | 11 | @Test 12 | fun booleanDefaultChangeTest() { 13 | testValues(pref::p_isMonsterKiller, null, true, false, true, null) 14 | } 15 | 16 | @Test 17 | fun intDefaultChangeTest() { 18 | testValues(pref::p_monstersKilled, null, 10, 0, 10, -19) 19 | } 20 | 21 | @Test 22 | fun longDefaultChangeTest() { 23 | testValues(pref::p_numberOfHahaInLough, null, 10L, 0L, 100L) 24 | } 25 | 26 | @Test 27 | fun floatDefaultChangeTest() { 28 | testValues(pref::p_experience, null, 10F, 0F, 100F) 29 | } 30 | 31 | @Test 32 | fun stringDefaultChangeTest() { 33 | testValues(pref::p_className, null, "BlueberryPie", "SuperPie") 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/bindings/PutValueExt.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences.bindings 2 | 3 | import android.content.SharedPreferences 4 | import com.marcinmoskala.kotlinpreferences.fromJson 5 | import com.marcinmoskala.kotlinpreferences.toJson 6 | import kotlin.reflect.KClass 7 | 8 | internal fun SharedPreferences.Editor.putValue(clazz: KClass<*>, value: Any, key: String) { 9 | when (clazz.simpleName) { 10 | "Long" -> putLong(key, value as Long) 11 | "Int" -> putInt(key, value as Int) 12 | "String" -> putString(key, value as String?) 13 | "Boolean" -> putBoolean(key, value as Boolean) 14 | "Float" -> putFloat(key, value as Float) 15 | else -> putString(key, value.toJson()) 16 | } 17 | } 18 | 19 | internal fun SharedPreferences.getValue(clazz: KClass<*>, default: T?, key: String): T = when (clazz.simpleName) { 20 | "Long" -> getLong(key, default as Long) 21 | "Int" -> getInt(key, default as Int) 22 | "String" -> getString(key, default as? String) 23 | "Boolean" -> getBoolean(key, default as Boolean) 24 | "Float" -> getFloat(key, default as Float) 25 | else -> getString(key, default?.toJson()).fromJson(clazz) 26 | } as T 27 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/SpeedComparationTest.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Assert 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | import kotlin.reflect.KMutableProperty0 9 | 10 | @RunWith(AndroidJUnit4::class) 11 | class SpeedComparationTest: BaseTest() { 12 | 13 | fun measureTime(f: () -> Unit): Long { 14 | val startTime = System.currentTimeMillis() 15 | f() 16 | val endTime = System.currentTimeMillis() 17 | return endTime - startTime 18 | } 19 | 20 | @Test 21 | fun propertyReadTest() { 22 | val normalReadTime = getReadTime(pref::f) 23 | val propertyReadTime = getReadTime(pref::p) 24 | Assert.assertTrue(normalReadTime > propertyReadTime) 25 | } 26 | 27 | @Test 28 | fun propertyWriteTest() { 29 | val bigList = ListPackage((1..10000).toList()) 30 | val normalWriteTime = measureTime { 31 | pref.f = bigList 32 | } 33 | val propertyWriteTime = measureTime { 34 | pref.p = bigList 35 | } 36 | Assert.assertTrue(normalWriteTime > propertyWriteTime) 37 | } 38 | 39 | private fun getReadTime(property: KMutableProperty0): Long { 40 | property.set(ListPackage((1..10).toList())) 41 | return measureTime { 42 | repeat(100) { property.get() } 43 | } 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/bindings/PreferenceFieldDelegateNullable.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("UNCHECKED_CAST") 2 | 3 | package com.marcinmoskala.kotlinpreferences.bindings 4 | 5 | import android.content.SharedPreferences 6 | import com.marcinmoskala.kotlinpreferences.fromJson 7 | import kotlin.properties.ReadWriteProperty 8 | import kotlin.reflect.KClass 9 | import kotlin.reflect.KProperty 10 | 11 | internal open class PreferenceFieldDelegateNullable(val clazz: KClass, val key: String? = null) : ReadWriteProperty { 12 | 13 | override operator fun getValue(thisRef: SharedPreferences, property: KProperty<*>): T? = readValue(thisRef, property) 14 | 15 | override fun setValue(thisRef: SharedPreferences, property: KProperty<*>, value: T?) { 16 | if (value == null) { 17 | removeValue(thisRef, property) 18 | } else { 19 | saveValue(thisRef, property, value) 20 | } 21 | } 22 | 23 | private fun readValue(pref: SharedPreferences, property: KProperty<*>): T? { 24 | val key = getKey(property) 25 | if (!pref.contains(key)) return null 26 | return pref.getByKey(key) 27 | } 28 | 29 | private fun SharedPreferences.getByKey(key: String): T? = when (clazz.simpleName) { 30 | "Long" -> getLong(key, -1L) as? T 31 | "Int" -> getInt(key, -1) as? T 32 | "String" -> getString(key, null) as? T 33 | "Boolean" -> getBoolean(key, false) as? T 34 | "Float" -> getFloat(key, -1.0F) as T 35 | else -> getString(key, null)?.fromJson(clazz) 36 | } 37 | 38 | private fun removeValue(pref: SharedPreferences, property: KProperty<*>) { 39 | pref.edit() 40 | .remove(getKey(property)) 41 | .apply() 42 | } 43 | 44 | private fun saveValue(pref: SharedPreferences, property: KProperty<*>, value: T) { 45 | pref.edit().apply { putValue(clazz, value, getKey(property)) }.apply() 46 | } 47 | 48 | private fun getKey(property: KProperty<*>) = key ?: "${property.name}Key" 49 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/main/java/com/marcinmoskala/kotlinpreferences/KotlinPreferences.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.content.SharedPreferences 4 | import com.marcinmoskala.kotlinpreferences.bindings.PreferenceFieldDelegate 5 | import com.marcinmoskala.kotlinpreferences.bindings.PreferenceFieldDelegateNullable 6 | import com.marcinmoskala.kotlinpreferences.bindings.PropertyWithBackup 7 | import com.marcinmoskala.kotlinpreferences.bindings.PropertyWithBackupNullable 8 | import kotlin.properties.ReadWriteProperty 9 | import kotlin.reflect.KClass 10 | 11 | inline fun bindToPreferenceField(default: T?, key: String? = null): ReadWriteProperty 12 | = bindToPreferenceField(T::class, default, key) 13 | 14 | inline fun bindToPreferenceFieldNullable(key: String? = null): ReadWriteProperty 15 | = bindToPreferenceFieldNullable(T::class, key) 16 | 17 | inline fun bindAsPropertyWithBackup(default: T?, key: String? = null): ReadWriteProperty 18 | = bindAsPropertyWithBackup(T::class, default, key) 19 | 20 | inline fun bindAsPropertyWithBackupNullable(key: String? = null): ReadWriteProperty 21 | = bindAsPropertyWithBackupNullable(T::class, key) 22 | 23 | fun bindToPreferenceField(clazz: KClass, default: T?, key: String? = null): ReadWriteProperty 24 | = PreferenceFieldDelegate(clazz, default, key) 25 | 26 | fun bindToPreferenceFieldNullable(clazz: KClass, key: String? = null): ReadWriteProperty 27 | = PreferenceFieldDelegateNullable(clazz, key) 28 | 29 | fun bindAsPropertyWithBackup(clazz: KClass, default: T?, key: String? = null): ReadWriteProperty 30 | = PropertyWithBackup(clazz, default, key) 31 | 32 | fun bindAsPropertyWithBackupNullable(clazz: KClass, key: String? = null): ReadWriteProperty 33 | = PropertyWithBackupNullable(clazz, key) -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/ExampleConfig.kt: -------------------------------------------------------------------------------- 1 | package com.marcinmoskala.kotlinpreferences 2 | 3 | import android.content.SharedPreferences 4 | 5 | var SharedPreferences.canEatPie: Boolean by bindToPreferenceField(true) 6 | var SharedPreferences.pieBaked: Int by bindToPreferenceField(5) 7 | var SharedPreferences.allPieInTheWorld: Long by bindToPreferenceField(-1L) 8 | var SharedPreferences.pieEaten: Float by bindToPreferenceField(0.0F) 9 | var SharedPreferences.bestPieName: String by bindToPreferenceField("Pie") 10 | 11 | var SharedPreferences.isMonsterKiller: Boolean? by bindToPreferenceFieldNullable() 12 | var SharedPreferences.monstersKilled: Int? by bindToPreferenceFieldNullable() 13 | var SharedPreferences.numberOfHahaInLough: Long? by bindToPreferenceFieldNullable() 14 | var SharedPreferences.experience: Float? by bindToPreferenceFieldNullable() 15 | var SharedPreferences.className: String? by bindToPreferenceFieldNullable() 16 | 17 | var SharedPreferences.character: Character? by bindToPreferenceFieldNullable() 18 | var SharedPreferences.savedGame: Game? by bindToPreferenceFieldNullable() 19 | 20 | 21 | var SharedPreferences.p_canEatPie: Boolean by bindAsPropertyWithBackup(true) 22 | var SharedPreferences.p_pieBaked: Int by bindAsPropertyWithBackup(5) 23 | var SharedPreferences.p_allPieInTheWorld: Long by bindAsPropertyWithBackup(-1L) 24 | var SharedPreferences.p_pieEaten: Float by bindAsPropertyWithBackup(0.0F) 25 | var SharedPreferences.p_bestPieName: String by bindAsPropertyWithBackup("Pie") 26 | 27 | var SharedPreferences.p_isMonsterKiller: Boolean? by bindAsPropertyWithBackupNullable() 28 | var SharedPreferences.p_monstersKilled: Int? by bindAsPropertyWithBackupNullable() 29 | var SharedPreferences.p_numberOfHahaInLough: Long? by bindAsPropertyWithBackupNullable() 30 | var SharedPreferences.p_experience: Float? by bindAsPropertyWithBackupNullable() 31 | var SharedPreferences.p_className: String? by bindAsPropertyWithBackupNullable() 32 | 33 | var SharedPreferences.p_character: Character? by bindAsPropertyWithBackupNullable() 34 | var SharedPreferences.p_savedGame: Game? by bindAsPropertyWithBackupNullable() 35 | 36 | var SharedPreferences.f: ListPackage? by bindToPreferenceFieldNullable() 37 | var SharedPreferences.p: ListPackage? by bindAsPropertyWithBackupNullable() 38 | 39 | data class ListPackage(val list: List) 40 | 41 | data class Character( 42 | val name: String, 43 | val race: String, 44 | val clazz: String 45 | ) 46 | 47 | data class Game( 48 | val character: Character, 49 | val gameMode: GameMode, 50 | val level: Int 51 | ) 52 | 53 | enum class GameMode { 54 | Easy, Normal, Hard 55 | } -------------------------------------------------------------------------------- /kotlinpreferences-lib/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.library' 2 | apply plugin: 'kotlin-android' 3 | 4 | apply plugin: 'com.github.dcendents.android-maven' 5 | 6 | group='com.marcinmoskala.kotlinpreferences' 7 | 8 | android { 9 | compileSdkVersion 25 10 | buildToolsVersion "25.0.2" 11 | 12 | defaultConfig { 13 | minSdkVersion 9 14 | targetSdkVersion 25 15 | versionCode 1 16 | versionName "1.0" 17 | 18 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 19 | 20 | } 21 | buildTypes { 22 | release { 23 | minifyEnabled false 24 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 25 | } 26 | } 27 | sourceSets { 28 | main.java.srcDirs += 'src/main/kotlin' 29 | } 30 | } 31 | 32 | dependencies { 33 | compile fileTree(dir: 'libs', include: ['*.jar']) 34 | compile 'com.android.support:appcompat-v7:25.1.0' 35 | compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 36 | compile "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version" 37 | compile "com.google.code.gson:gson:2.4" 38 | 39 | testCompile 'junit:junit:4.12' 40 | androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { 41 | exclude group: 'com.android.support', module: 'support-annotations' 42 | }) 43 | } 44 | repositories { 45 | mavenCentral() 46 | } 47 | 48 | // Fancy test print 49 | tasks.withType(Test) { 50 | testLogging { 51 | // set options for log level LIFECYCLE 52 | events "passed", "skipped", "failed", "standardOut" 53 | showExceptions true 54 | exceptionFormat "full" 55 | showCauses true 56 | showStackTraces true 57 | 58 | // set options for log level DEBUG and INFO 59 | debug { 60 | events "started", "passed", "skipped", "failed", "standardOut", "standardError" 61 | exceptionFormat "full" 62 | } 63 | info.events = debug.events 64 | info.exceptionFormat = debug.exceptionFormat 65 | 66 | afterSuite { desc, result -> 67 | if (!desc.parent) { // will match the outermost suite 68 | def output = "Results: ${result.resultType} (${result.testCount} tests, ${result.successfulTestCount} successes, ${result.failedTestCount} failures, ${result.skippedTestCount} skipped)" 69 | def startItem = '| ', endItem = ' |' 70 | def repeatLength = startItem.length() + output.length() + endItem.length() 71 | println('\n' + ('-' * repeatLength) + '\n' + startItem + output + endItem + '\n' + ('-' * repeatLength)) 72 | } 73 | } 74 | } 75 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # KotlinPreferences 2 | Kotlin Android Library, that makes preference usage simple and fun. 3 | 4 | [![](https://jitpack.io/v/marcinmoskala/kotlinpreferences.svg)](https://jitpack.io/#marcinmoskala/kotlinpreferences) 5 | [![Build Status](https://travis-ci.org/MarcinMoskala/KotlinPreferences.svg?branch=master)](https://travis-ci.org/MarcinMoskala/KotlinPreferences) 6 | [![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin) 7 | [![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) 8 | 9 | KotlinPreferences now have a [brother](https://github.com/MarcinMoskala/KotlinPreferencesObject). 10 | 11 | With KotlinPreferences, you can define different preference fields this way: 12 | 13 | ```kotlin 14 | var SharedPreferences.canEatPie: Boolean by bindToPreferenceField(true) 15 | ``` 16 | 17 | And use it like any SharedPreference property: 18 | ```kotlin 19 | preferences.canEatPie = true 20 | if(preferences.canEatPie) //... 21 | ``` 22 | 23 | There are different ways to define this properties. Here are some possibilities: (see full example [here](https://github.com/MarcinMoskala/KotlinPreferences/blob/master/kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences/ExampleConfig.kt) and usage [here](https://github.com/MarcinMoskala/KotlinPreferences/tree/master/kotlinpreferences-lib/src/androidTest/java/com/marcinmoskala/kotlinpreferences)) 24 | 25 | With default value: 26 | ```kotlin 27 | var SharedPreferences.canEatPie: Boolean by bindToPreferenceField(true) 28 | var SharedPreferences.allPieInTheWorld: Long by bindToPreferenceField(0) 29 | ``` 30 | 31 | Nullable: 32 | ```kotlin 33 | var SharedPreferences.monstersKilled: Int? by bindToPreferenceFieldNullable() 34 | var SharedPreferences.experience: Float? by bindToPreferenceFieldNullable() 35 | var SharedPreferences.className: String? by bindToPreferenceFieldNullable() 36 | ``` 37 | 38 | Can also keep other objects: 39 | ```kotlin 40 | var SharedPreferences.character: Character by bindToPreferenceFieldNullable() 41 | var SharedPreferences.savedGame: Game? by bindToPreferenceFieldNullable() 42 | ``` 43 | Node that this objects are serialized do string using Gson. If they include some, types that needs some serializers, then you need to set gson with converters. Instructions [here](https://github.com/MarcinMoskala/KotlinPreferences/wiki/Setting-gson). 44 | 45 | Also keys can be specyfied: (this is important to make values immtuable to property name in case of changes in the app) 46 | ```kotlin 47 | var SharedPreferences.monstersKilled: Int? by bindToPreferenceFieldNullable("MonstersKilledKey") 48 | var SharedPreferences.allPieInTheWorld: Long by bindToPreferenceField(0, "AllPieKey") 49 | ``` 50 | 51 | ## Install 52 | 53 | To add KotlinPreferences to the project, add in build.gradle file: 54 | 55 | ```groovy 56 | dependencies { 57 | compile 'com.github.marcinmoskala:kotlinpreferences:1.00' 58 | } 59 | ``` 60 | 61 | And while library is located on JitPack, remember to add on module build.gradle (unless you already have it): 62 | 63 | ```groovy 64 | repositories { 65 | maven { url 'https://jitpack.io' } 66 | } 67 | ``` 68 | 69 | 70 | License 71 | ------- 72 | 73 | Copyright 2017 Marcin Moskała 74 | 75 | Licensed under the Apache License, Version 2.0 (the "License"); 76 | you may not use this file except in compliance with the License. 77 | You may obtain a copy of the License at 78 | 79 | http://www.apache.org/licenses/LICENSE-2.0 80 | 81 | Unless required by applicable law or agreed to in writing, software 82 | distributed under the License is distributed on an "AS IS" BASIS, 83 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 84 | See the License for the specific language governing permissions and 85 | limitations under the License. 86 | 87 | 88 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >/dev/null 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >/dev/null 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------