data.java.JAutoSavePluginData.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mirai-console Show documentation
Mirai Console Backend
There is a newer version: 2.16.0
/*
 * Copyright 2019-2020 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AFFERO GENERAL PUBLIC LICENSE version 3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/master/LICENSE
 */

@file:Suppress("unused", "EXPOSED_SUPER_CLASS")

package net.mamoe.mirai.console.data.java

import net.mamoe.mirai.console.data.*
import net.mamoe.mirai.console.internal.data.cast
import net.mamoe.mirai.console.internal.data.setValueBySerializer
import net.mamoe.mirai.console.internal.data.valueImpl
import net.mamoe.mirai.console.plugin.jvm.JvmPlugin
import kotlin.reflect.KClass
import kotlin.reflect.KType
import kotlin.reflect.KTypeProjection
import kotlin.reflect.full.createType

/**
 * 供 Java 用户使用的 [PluginData]. 参考 [PluginData] 以获取更多信息.
 *
 * 在 [JvmPlugin] 的典型实现方式:
 * ```
 * // PluginMain.java
 * public final class PluginMain extends JavaPlugin {
 *     public static PluginMain INSTANCE;
 *     public PluginMain() {
 *          INSTANCE = this;
 *     }
 *     @Override
 *     public onLoad() {
 *          this.reloadPluginData(MyPluginData.INSTANCE); // 读取文件等
 *     }
 * }
 *
 * // MyPluginData.java
 * public class MyPluginData extends JAutoSavePluginData {
 *     public static final MyPluginData INSTANCE = new MyPluginData();
 *
 *     public final Value string = value("test"); // 默认值 "test"
 *
 *     public final Value> list = typedValue(createKType(List.class, createKType(String.class))); // 无默认值, 自动创建空 List
 *
 *     public final Value> custom = typedValue(
 *             createKType(Map.class, createKType(Long.class), createKType(Object.class)),
 *             new HashMap() {{ // 带默认值
 *                 put(123L, "ok");
 *             }}
 *     );
 * }
 * ```
 *
 * 使用时, 需要使用 `.get()`, 如:
 * ```
 * Value> theList = MyPluginData.INSTANCE.list; // 获取 Value 实例. Value 代表一个追踪自动保存的值.
 * List actualList = theList.get();
 * theList.set();
 * ```
 *
 * **注意**: 由于实现特殊, 请不要在初始化 Value 时就使用 `.get()`. 这可能会导致自动保存追踪失效. 必须在使用时才调用 `.get()` 获取真实数据对象.
 *
 * @see PluginData
 */
public abstract class JAutoSavePluginData public constructor(saveName: String) : AutoSavePluginData(saveName), PluginConfig {

    //// region JPluginData_value_primitives CODEGEN ////

    /**
     * 创建一个 [Byte] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Byte): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Short] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Short): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Int] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Int): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Long] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Long): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Float] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Float): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Double] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Double): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Char] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Char): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [Boolean] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: Boolean): SerializerAwareValue = valueImpl(default)

    /**
     * 创建一个 [String] 类型的 [Value], 并设置初始值为 [default]
     */
    public fun value(default: String): SerializerAwareValue = valueImpl(default)

    //// endregion JPluginData_value_primitives CODEGEN ////

    /**
     * 构造一个支持泛型的 [Value].
     *
     * 对于 [Map], [Set], [List] 等标准库类型, 这个函数会尝试构造 [LinkedHashMap], [LinkedHashSet], [ArrayList] 等相关类型.
     * 而对于自定义数据类型, 本函数只会反射获取 [objectInstance][KClass.objectInstance] 或使用*无参构造器*构造实例.
     *
     * @param type Kotlin 类型. 可通过 [createKType] 获得
     *
     * @param T 类型 T. 仅支持:
     * - 基础数据类型, [String]
     * - 标准库集合类型 ([List], [Map], [Set])
     * - 标准库数据类型 ([Map.Entry], [Pair], [Triple])
     * - 使用 [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization) 的 [Serializable] 标记的类
     */
    @JvmOverloads
    public fun  typedValue(type: KType, default: T? = null): SerializerAwareValue {
        val value = valueImpl(type, type.classifier!!.cast())
        if (default != null) value.setValueBySerializer(default)
        return value
    }

    public companion object {
        /**
         * 根据 [Class] 及泛型参数获得一个类型
         *
         * 如要获得一个 `Map` 的类型,
         * ```java
         * KType type = JPluginDataHelper.createKType(Map.java, createKType(String.java), createKType(Long.java))
         * ```
         *
         * @param genericArguments 带有顺序的泛型参数
         */
        @JvmStatic
        public fun  createKType(clazz: Class, nullable: Boolean, vararg genericArguments: KType): KType {
            return clazz.kotlin.createType(genericArguments.map { KTypeProjection(null, it) }, nullable)
        }

        /**
         * 根据 [Class] 及泛型参数获得一个不可为 `null` 的类型
         *
         * @see createKType
         */
        @JvmStatic
        public fun  createKType(clazz: Class, vararg genericArguments: KType): KType {
            return createKType(clazz, false, *genericArguments)
        }
    }
}