增加 ConfigController.java 的注释

This commit is contained in:
许轲 2023-10-11 02:11:33 +08:00
parent 9c3473a166
commit db004a23b0

View File

@ -4,22 +4,36 @@ import java.nio.file.Path;
/** /**
* 配置文件控制器接口 * 配置文件控制器接口
* <p>
* 该接口定义了配置文件相关的操作包括加载持久化创建和获取配置文件路径等
* </p>
*
* @param <T> 配置文件类型
* *
* @author gewuyou * @author gewuyou
*/ */
public interface ConfigController<T> { public interface ConfigController<T> {
/** /**
* 加载配置文件内容 * 加载配置文件内容
* <p>
* 从配置文件中加载配置信息
* </p>
*/ */
void loadConfig(); void loadConfig();
/** /**
* 配置文件持久化 * 配置文件持久化
* <p>
* 将配置信息持久化到配置文件中
* </p>
*/ */
void writeConfig(); void writeConfig();
/** /**
* 配置文件持久化 * 配置文件持久化
* <p>
* 将指定的配置对象持久化到配置文件中
* </p>
* *
* @param config 配置文件对象 * @param config 配置文件对象
*/ */
@ -27,19 +41,28 @@ public interface ConfigController<T> {
/** /**
* 如果配置文件不存在则创建 * 如果配置文件不存在则创建
* <p>
* 在需要的情况下创建配置文件如果配置文件已存在则不执行任何操作
* </p>
*/ */
void createConfigIfNotExists(); void createConfigIfNotExists();
/** /**
* 创建配置文件实体 * 创建配置文件实体
* <p>
* 生成默认的配置文件实体对象用于后续的序列化操作
* </p>
* *
* @return 默认的配置文件实体 * @return 默认的配置文件实体
* @apiNote 返回默认的配置文件实体用于序列化json * @apiNote 返回默认的配置文件实体用于序列化 JSON 数据
*/ */
T generateDefaultConfig(); T generateDefaultConfig();
/** /**
* 获取配置文件路径 * 获取配置文件路径
* <p>
* 返回配置文件的路径
* </p>
* *
* @return 配置文件路径 * @return 配置文件路径
*/ */