doc: 调整代码文档注释格式.

This commit is contained in:
2024-10-05 13:27:43 +08:00
parent 3e8b90963b
commit 0cc25559d2
52 changed files with 54 additions and 1 deletions

View File

@@ -7,6 +7,7 @@ import com.serliunx.ddns.support.SystemInitializer;
/** /**
* 启动类 * 启动类
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -11,6 +11,7 @@ import feign.slf4j.Slf4jLogger;
/** /**
* 本机外网IP地址获取 * 本机外网IP地址获取
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.client.entity;
/** /**
* IP地址查询响应 * IP地址查询响应
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -11,6 +11,7 @@ import java.util.concurrent.locks.ReentrantLock;
/** /**
* 配置信息的抽象实现, 定义公共逻辑 * 配置信息的抽象实现, 定义公共逻辑
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -7,6 +7,7 @@ import java.util.Map;
/** /**
* 配置信息逻辑定义 * 配置信息逻辑定义
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.config;
/** /**
* 配置文件键常量信息 * 配置文件键常量信息
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.config;
/** /**
* 文件配置管理 * 文件配置管理
*
* @see PropertiesConfiguration * @see PropertiesConfiguration
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0

View File

@@ -10,6 +10,7 @@ import java.util.Set;
/** /**
* 使用{@link Properties}实现的简单读取键值对形式的配置信息实现 * 使用{@link Properties}实现的简单读取键值对形式的配置信息实现
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -9,6 +9,7 @@ import java.util.Map;
/** /**
* yml/yaml格式的配置文件目前用于语言文件 * yml/yaml格式的配置文件目前用于语言文件
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/6/17 * @since 2024/6/17

View File

@@ -9,6 +9,7 @@ import java.util.Map;
/** /**
* 实例类型集合 * 实例类型集合
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.constant;
/** /**
* 保存实例的文件类型: XML、JSON等 * 保存实例的文件类型: XML、JSON等
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -4,6 +4,7 @@ import static com.serliunx.ddns.constant.SystemConstants.*;
/** /**
* 实例来源 * 实例来源
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.constant;
/** /**
* 实例类型: 阿里云、华为云、腾讯云等 * 实例类型: 阿里云、华为云、腾讯云等
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -4,6 +4,7 @@ import java.io.File;
/** /**
* 系统常量 * 系统常量
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -3,6 +3,7 @@ package com.serliunx.ddns.core;
/** /**
* 定义一个实体的清理逻辑 * 定义一个实体的清理逻辑
* <li> 一般用来清理中间加载过程中所产生的无用对象 * <li> 一般用来清理中间加载过程中所产生的无用对象
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -5,6 +5,7 @@ import java.io.FileFilter;
/** /**
* 文件过滤器, 用于加载过滤存储在文件中的实例信息时 * 文件过滤器, 用于加载过滤存储在文件中的实例信息时
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -3,6 +3,7 @@ package com.serliunx.ddns.core;
/** /**
* 定义一个对象的优先级 * 定义一个对象的优先级
* <li> 数字越大, 优先级越小 * <li> 数字越大, 优先级越小
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.core;
/** /**
* 刷新逻辑 * 刷新逻辑
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -19,6 +19,7 @@ import static com.serliunx.ddns.util.InstanceUtils.validateInstance;
/** /**
* 实例容器的抽象实现, 定义大部分公共逻辑 * 实例容器的抽象实现, 定义大部分公共逻辑
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -7,6 +7,7 @@ import com.serliunx.ddns.core.factory.YamlFileInstanceFactory;
/** /**
* 文件形式的实例容器 * 文件形式的实例容器
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.core.context;
/** /**
* 简易的容器实现, 需要手动进行刷新、添加实例工厂. * 简易的容器实现, 需要手动进行刷新、添加实例工厂.
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/25 * @since 2024/5/25

View File

@@ -4,6 +4,7 @@ import com.serliunx.ddns.core.factory.InstanceFactory;
/** /**
* 实例容器接口定义 * 实例容器接口定义
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -10,6 +10,7 @@ import java.util.stream.Collectors;
/** /**
* 多数据源的实例容器, 将多种实例来源汇聚到一起 * 多数据源的实例容器, 将多种实例来源汇聚到一起
*
* @see InstanceFactory * @see InstanceFactory
* @see InstanceContext * @see InstanceContext
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>

View File

@@ -13,6 +13,7 @@ import static com.serliunx.ddns.util.InstanceUtils.validateInstance;
/** /**
* 实例工厂抽象实现, 定义通用逻辑及实例存储. * 实例工厂抽象实现, 定义通用逻辑及实例存储.
*
* @see FileInstanceFactory * @see FileInstanceFactory
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0

View File

@@ -8,6 +8,7 @@ import com.serliunx.ddns.core.instance.Instance;
/** /**
* 简单的实例工厂逻辑定义, 添加、获取实例. * 简单的实例工厂逻辑定义, 添加、获取实例.
* <li> 属于顶层接口, 定义了通用行为: 如刷新和清理逻辑、排序规则等. * <li> 属于顶层接口, 定义了通用行为: 如刷新和清理逻辑、排序规则等.
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -12,6 +12,7 @@ import static com.serliunx.ddns.constant.InstanceClasses.match;
/** /**
* Jackson文件实例工厂, 使用jackson的ObjectMapper来分别处理json和xml * Jackson文件实例工厂, 使用jackson的ObjectMapper来分别处理json和xml
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -6,6 +6,7 @@ import com.serliunx.ddns.core.instance.Instance;
/** /**
* Jackson-Json文件实例工厂 * Jackson-Json文件实例工厂
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -8,6 +8,7 @@ import java.util.Set;
/** /**
* 扩展型实自工厂接口, 定义了批量获取、筛选实例的方式. * 扩展型实自工厂接口, 定义了批量获取、筛选实例的方式.
*
* @see InstanceFactory * @see InstanceFactory
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0

View File

@@ -6,6 +6,7 @@ import com.serliunx.ddns.core.instance.Instance;
/** /**
* Jackson-Xml文件实例工厂 * Jackson-Xml文件实例工厂
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -21,6 +21,7 @@ import static com.serliunx.ddns.constant.SystemConstants.TYPE_FIELD;
/** /**
* Yaml文件实例工厂, 使用SnakeYaml来反序列化实例. 属于文件型实例工厂. * Yaml文件实例工厂, 使用SnakeYaml来反序列化实例. 属于文件型实例工厂.
*
* @see FileInstanceFactory * @see FileInstanceFactory
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0

View File

@@ -14,6 +14,7 @@ import static com.serliunx.ddns.constant.SystemConstants.XML_ROOT_INSTANCE_NAME;
/** /**
* 实例抽象实现 * 实例抽象实现
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -21,6 +21,7 @@ import static com.serliunx.ddns.constant.SystemConstants.XML_ROOT_INSTANCE_NAME;
/** /**
* 阿里云实例定义 * 阿里云实例定义
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.core.instance;
/** /**
* 华为云实例定义 * 华为云实例定义
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -6,6 +6,7 @@ import com.serliunx.ddns.core.Refreshable;
/** /**
* 实例行为、参数定义接口 * 实例行为、参数定义接口
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.core.instance;
/** /**
* 腾讯云实例定义 * 腾讯云实例定义
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.exception;
/** /**
* 实例相关异常信息 * 实例相关异常信息
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -4,6 +4,7 @@ import com.serliunx.ddns.core.instance.Instance;
/** /**
* 异常信息, 实例已存在 * 异常信息, 实例已存在
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -4,6 +4,7 @@ import java.util.Collection;
/** /**
* 断言 * 断言
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15
@@ -17,9 +18,10 @@ public final class Assert {
} }
public static void notNull(Object object, String msg) { public static void notNull(Object object, String msg) {
if(object == null) if(object == null) {
throw new NullPointerException(msg); throw new NullPointerException(msg);
} }
}
public static void notNull(Object...objects) { public static void notNull(Object...objects) {
for (Object object : objects) { for (Object object : objects) {

View File

@@ -5,6 +5,7 @@ import com.serliunx.ddns.config.Configuration;
/** /**
* 配置信息上下文 * 配置信息上下文
* <li> {@link Configuration} * <li> {@link Configuration}
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.1 * @version 1.0.1
* @since 2024/7/8 * @since 2024/7/8

View File

@@ -5,6 +5,7 @@ import com.serliunx.ddns.core.context.MultipleSourceInstanceContext;
/** /**
* 系统启动配置器 * 系统启动配置器
*
* @see SystemInitializer * @see SystemInitializer
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0

View File

@@ -4,6 +4,7 @@ import com.serliunx.ddns.core.instance.Instance;
/** /**
* 实例信息上下文 * 实例信息上下文
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/6/15 * @since 2024/6/15

View File

@@ -10,6 +10,7 @@ import java.util.concurrent.locks.ReentrantLock;
/** /**
* 网络参数上下文, 目前仅用于存储本机网络IP * 网络参数上下文, 目前仅用于存储本机网络IP
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -30,6 +30,7 @@ import static com.serliunx.ddns.config.ConfigurationKeys.KEY_THREAD_POOL_CORE_SI
/** /**
* 系统初始化 * 系统初始化
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -14,6 +14,7 @@ import java.util.Collections;
/** /**
* feign解码器 * feign解码器
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -16,6 +16,7 @@ import java.util.Collections;
/** /**
* Feign兼容Jackson(反序列化返回值) * Feign兼容Jackson(反序列化返回值)
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -8,6 +8,7 @@ import static ch.qos.logback.core.pattern.color.ANSIConstants.*;
/** /**
* 高亮颜色转换器 * 高亮颜色转换器
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.1 * @version 1.0.1
* @since 2024/6/15 * @since 2024/6/15

View File

@@ -7,6 +7,7 @@ import com.serliunx.ddns.support.InstanceContextHolder;
/** /**
* 获取当前任何线程的实例信息或者附加信息 * 获取当前任何线程的实例信息或者附加信息
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/6/15 * @since 2024/6/15

View File

@@ -7,6 +7,7 @@ import java.lang.management.ManagementFactory;
/** /**
* 日志变量%pid(进程id) 转换器 * 日志变量%pid(进程id) 转换器
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/6/15 * @since 2024/6/15

View File

@@ -8,6 +8,7 @@ import java.util.concurrent.atomic.AtomicInteger;
/** /**
* 简易的实例活动相关的线程工厂, 仅仅定义了线程的名称规则. * 简易的实例活动相关的线程工厂, 仅仅定义了线程的名称规则.
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -2,6 +2,7 @@ package com.serliunx.ddns.thread;
/** /**
* 同 {@link TaskThreadFactory}, 暂未使用. * 同 {@link TaskThreadFactory}, 暂未使用.
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -5,6 +5,7 @@ import com.serliunx.ddns.support.Assert;
/** /**
* 实例相关工具方法集合 * 实例相关工具方法集合
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15

View File

@@ -6,6 +6,7 @@ import java.util.List;
/** /**
* 反射相关工具类 * 反射相关工具类
*
* @author <a href="mailto:serliunx@yeah.net">SerLiunx</a> * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
* @version 1.0.0 * @version 1.0.0
* @since 2024/5/15 * @since 2024/5/15