kdoc see ref and fixed hackDelegates load json

Author: emyfops

common/src/main/kotlin/com/lambda/config/AbstractSetting.kt

@@ -72,7 +72,7 @@ import kotlin.reflect.KProperty
  */
 abstract class AbstractSetting<T : Any>(
     private val defaultValue: T,
-    private val type: Type,
+    protected val type: Type,
     val description: String,
     val visibility: () -> Boolean,
 ) : Jsonable, Nameable {

common/src/main/kotlin/com/lambda/config/Configurable.kt

@@ -278,6 +278,8 @@ abstract class Configurable(
     /**
      * Creates a [ByteSetting] with the provided parameters and adds it to the [settings].
      *
+     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
+     *
      * @param name The unique identifier for the setting.
      * @param defaultValue The default [Byte] value of the setting.
      * @param range The range within which the setting's value must fall.
@@ -303,6 +305,8 @@ abstract class Configurable(
     /**
      * Creates a [DoubleSetting] with the provided parameters and adds it to the [settings].
      *
+     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
+     *
      * @param name The unique identifier for the setting.
      * @param defaultValue The default [Double] value of the setting.
      * @param range The range within which the setting's value must fall.
@@ -328,6 +332,8 @@ abstract class Configurable(
     /**
      * Creates a [FloatSetting] with the provided parameters and adds it to the [settings].
      *
+     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
+     *
      * @param name The unique identifier for the setting.
      * @param defaultValue The default [Float] value of the setting.
      * @param range The range within which the setting's value must fall.
@@ -353,6 +359,8 @@ abstract class Configurable(
     /**
      * Creates an [IntegerSetting] with the provided parameters and adds it to the [settings].
      *
+     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
+     *
      * @param name The unique identifier for the setting.
      * @param defaultValue The default [Int] value of the setting.
      * @param range The range within which the setting's value must fall.
@@ -378,6 +386,8 @@ abstract class Configurable(
     /**
      * Creates a [LongSetting] with the provided parameters and adds it to the [settings].
      *
+     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
+     *
      * @param name The unique identifier for the setting.
      * @param defaultValue The default [Long] value of the setting.
      * @param range The range within which the setting's value must fall.
@@ -403,6 +413,8 @@ abstract class Configurable(
     /**
      * Creates a [ShortSetting] with the provided parameters and adds it to the [settings].
      *
+     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
+     *
      * @param name The unique identifier for the setting.
      * @param defaultValue The default [Short] value of the setting.
      * @param range The range within which the setting's value must fall.

common/src/main/kotlin/com/lambda/config/settings/CharSetting.kt

@@ -21,12 +21,7 @@ import com.google.gson.reflect.TypeToken
 import com.lambda.config.AbstractSetting
 
 /**
- * Represents a [Char] setting.
- *
- * @property name The [name] of the setting.
- * @property defaultValue The default [Char] [value] of the setting.
- * @property visibility A function that determines whether the setting [isVisible].
- * @property description A [description] of the setting.
+ * @see [com.lambda.config.Configurable]
  */
 class CharSetting(
     override val name: String,

common/src/main/kotlin/com/lambda/config/settings/NumericSetting.kt

@@ -24,16 +24,7 @@ import java.util.*
 import kotlin.reflect.KProperty
 
 /**
- * Represents a [NumericSetting] with a specific [range] and [step].
- *
- * The [value] of the setting is coerced into the specified [range] and rounded to the nearest [step].
- * The [visibility] and [description] of the setting are inherited from [AbstractSetting].
- *
- * @property range The range within which the setting's [value] must fall.
- * @property step The [step] to which the setting's [value] is rounded.
- * @property visibility A function that determines whether the setting [isVisible].
- * @property description A [description] of the setting.
- * @property unit The unit of the setting's [value].
+ * @see [com.lambda.config.Configurable]
  */
 abstract class NumericSetting<T>(
     value: T,

common/src/main/kotlin/com/lambda/config/settings/StringSetting.kt

@@ -21,12 +21,7 @@ import com.google.gson.reflect.TypeToken
 import com.lambda.config.AbstractSetting
 
 /**
- * Represents a [String] setting.
- *
- * @property name The [name] of the setting.
- * @property defaultValue The default [String] [value] of the setting.
- * @property description A [description] of the setting.
- * @property visibility A function that determines whether the setting [isVisible].
+ * @see [com.lambda.config.Configurable]
  */
 class StringSetting(
     override val name: String,

common/src/main/kotlin/com/lambda/config/settings/collections/ListSetting.kt

@@ -18,9 +18,13 @@
 package com.lambda.config.settings.collections
 
 import com.google.gson.JsonElement
+import com.lambda.Lambda.gson
 import com.lambda.config.AbstractSetting
 import java.lang.reflect.Type
 
+/**
+ * @see [com.lambda.config.Configurable]
+ */
 class ListSetting<T : Any>(
     override val name: String,
     private val defaultValue: MutableList<T>,
@@ -35,7 +39,15 @@ class ListSetting<T : Any>(
     visibility
 ) {
     override fun toJson(): JsonElement {
-        if (hackDelegates) value = defaultValue
-        return super.toJson()
+        return if (hackDelegates) gson.toJsonTree(defaultValue, type)
+        else super.toJson()
+    }
+
+    override fun loadFromJson(serialized: JsonElement) {
+        if (hackDelegates) {
+            defaultValue.addAll(gson.fromJson(serialized, type))
+            setValue(this, ::value, defaultValue.distinct().toMutableList())
+        }
+        else super.loadFromJson(serialized)
     }
 }

common/src/main/kotlin/com/lambda/config/settings/collections/MapSetting.kt

@@ -18,24 +18,36 @@
 package com.lambda.config.settings.collections
 
 import com.google.gson.JsonElement
+import com.lambda.Lambda.gson
 import com.lambda.config.AbstractSetting
 import java.lang.reflect.Type
 
+/**
+ * @see [com.lambda.config.Configurable]
+ */
 class MapSetting<K, V>(
     override val name: String,
-    private val defaultValue: Map<K, V>,
+    private val defaultValue: MutableMap<K, V>,
     type: Type,
     description: String,
     private val hackDelegates: Boolean,
     visibility: () -> Boolean,
-) : AbstractSetting<Map<K, V>>(
+) : AbstractSetting<MutableMap<K, V>>(
     defaultValue,
     type,
     description,
     visibility
 ) {
     override fun toJson(): JsonElement {
-        if (hackDelegates) value = defaultValue
-        return super.toJson()
+        return if (hackDelegates) gson.toJsonTree(defaultValue, type)
+        else super.toJson()
+    }
+
+    override fun loadFromJson(serialized: JsonElement) {
+        if (hackDelegates) {
+            defaultValue.putAll(gson.fromJson(serialized, type))
+            setValue(this, ::value, defaultValue)
+        }
+        else super.loadFromJson(serialized)
     }
 }

common/src/main/kotlin/com/lambda/config/settings/collections/SetSetting.kt

@@ -18,9 +18,13 @@
 package com.lambda.config.settings.collections
 
 import com.google.gson.JsonElement
+import com.lambda.Lambda.gson
 import com.lambda.config.AbstractSetting
 import java.lang.reflect.Type
 
+/**
+ * @see [com.lambda.config.Configurable]
+ */
 class SetSetting<T : Any>(
     override val name: String,
     private val defaultValue: MutableSet<T>,
@@ -35,7 +39,15 @@ class SetSetting<T : Any>(
     visibility
 ) {
     override fun toJson(): JsonElement {
-        if (hackDelegates) value = defaultValue
-        return super.toJson()
+        return if (hackDelegates) gson.toJsonTree(defaultValue, type)
+        else super.toJson()
+    }
+
+    override fun loadFromJson(serialized: JsonElement) {
+        if (hackDelegates) {
+            defaultValue.addAll(gson.fromJson(serialized, type))
+            setValue(this, ::value, defaultValue.distinct().toMutableSet())
+        }
+        else super.loadFromJson(serialized)
     }
 }

common/src/main/kotlin/com/lambda/config/settings/comparable/BooleanSetting.kt

@@ -20,6 +20,9 @@ package com.lambda.config.settings.comparable
 import com.google.gson.reflect.TypeToken
 import com.lambda.config.AbstractSetting
 
+/**
+ * @see [com.lambda.config.Configurable]
+ */
 class BooleanSetting(
     override val name: String,
     defaultValue: Boolean,

common/src/main/kotlin/com/lambda/config/settings/comparable/EnumSetting.kt

@@ -20,6 +20,9 @@ package com.lambda.config.settings.comparable
 import com.google.gson.reflect.TypeToken
 import com.lambda.config.AbstractSetting
 
+/**
+ * @see [com.lambda.config.Configurable]
+ */
 class EnumSetting<T : Enum<T>>(
     override val name: String,
     defaultValue: T,