diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/package-info.java index 0ab9c77..b953d64 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/package-info.java @@ -24,17 +24,15 @@ * 标识静态工厂方法。 * 《Effective Java》的 Item1 建议考虑用静态工厂方法替换构造器, * 因而考虑有一个注解可以标记一下静态工厂方法,以和其它方法进行区分。 - *
* ** 分别标识读方法(如 getter)或写方法(如 setter)。 - *
+ * ** 最早是写了一个集合类,为了方便判断使用读写锁时,哪些情况下使用读锁,哪些情况下使用写锁。 - *
* ** 标识该方法不被支持或没有实现,将抛出 {@link UnsupportedOperationException}。 * 为了方便在使用时,不需要点进源码,就能知道该方法没有实现。 - *
* *- * Java 非 final 的实例方法,对应 C++/C# 中的虚方法,允许被子类覆写。 + * Java 非 final 的实例方法,对应 C++/C# 中的虚方法,允许被子类覆写。 * {@link Virtual} 注解旨在设计父类时,强调该方法父类虽然有默认实现,但子类可以根据自己的需要覆写。 - *
* ** 标记一个类,表示其作为值对象,区别于 Entity。 - *
* * @author ZhouXY */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/Ref.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/Ref.java index 4beae5d..38f551a 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/Ref.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/Ref.java @@ -27,7 +27,7 @@ import javax.annotation.Nullable; /** * {@link Ref} 包装了一个值,表示对该值的应用。 * - *灵感来自于 C# 的 {@value ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:
+ *灵感来自于 C# 的 {@code ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:
** void Method(ref int refArgument) * { @@ -51,7 +51,7 @@ import javax.annotation.Nullable; ** 当一个方法需要产生多个结果时,无法有多个返回值,可以使用 {@link Ref} 作为参数传入,方法内部修改 {@link Ref} 的值。 * 调用方在调用方法之后,使用 {@code getValue()} 获取结果。 - *
+ * ** String method(final Ref<Integer> intRefArgument, final Ref<String> strRefArgument) { * intRefArgument.transformValue(i -> i + 44); diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/package-info.java index 43dff12..e41fd29 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/package-info.java @@ -20,8 +20,8 @@ *1. Ref
** {@link Ref} 包装了一个值,表示对该值的应用。 - *
- *灵感来自于 C# 的 {@value ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:
+ * + *灵感来自于 C# 的 {@code ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:
** void Method(ref int refArgument) * { @@ -45,7 +45,7 @@ ** 当一个方法需要产生多个结果时,无法有多个返回值,可以使用 {@link Ref} 作为参数传入,方法内部修改 {@link Ref} 的值。 * 调用方在调用方法之后,使用 {@code getValue()} 获取结果。 - *
+ * ** String method(Ref<Integer> intRefArgument, Ref<String> strRefArgument) { * intRefArgument.transformValue(i -> i + 44); @@ -65,7 +65,6 @@ ** 类似于枚举这样的类型,通常需要设置固定的码值表示对应的含义。 * 可实现 {@link IWithCode}、{@link IWithIntCode}、{@link IWithLongCode},便于在需要的地方对这些接口的实现进行处理。 - *
* * @author ZhouXY */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/package-info.java index 5bfdc39..a463893 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/package-info.java @@ -15,7 +15,7 @@ */ /** - *集合
+ *
集合
* ** 1. {@link CollectionTools} diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/PatternConsts.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/PatternConsts.java index bf76fb0..afc80ec 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/PatternConsts.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/PatternConsts.java @@ -31,7 +31,7 @@ public final class PatternConsts { * yyyyMMdd * * @see RegexConsts#BASIC_ISO_DATE - * + * */ public static final Pattern BASIC_ISO_DATE = Pattern.compile(RegexConsts.BASIC_ISO_DATE); diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/package-info.java index 8e52806..0e1cfa9 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/package-info.java @@ -15,7 +15,7 @@ */ /** - *
常量
+ *
常量
* ** 1. 正则常量 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/MultiTypesException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/MultiTypesException.java index d94df8a..d0ade7b 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/MultiTypesException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/MultiTypesException.java @@ -24,13 +24,12 @@ import xyz.zhouxy.plusone.commons.base.IWithCode; * *
* 异常在不同场景下被抛出,可以用不同的枚举值,表示不同的场景类型。 - *
+ * ** 异常实现 {@link MultiTypesException} 的 {@link #getType} 方法,返回对应的场景类型。 - *
+ * ** 表示场景类型的枚举实现 {@link ExceptionType},其中的工厂方法用于创建对应类型的异常。 - *
* ** public final class LoginException @@ -61,7 +60,7 @@ import xyz.zhouxy.plusone.commons.base.IWithCode; * * // ... * - * public enum Type implements ExceptionType{ + * public enum Type implements ExceptionType<LoginException> { * DEFAULT("00", "当前会话未登录"), * NOT_TOKEN("10", "未提供token"), * INVALID_TOKEN("20", "token无效"), @@ -117,7 +116,6 @@ import xyz.zhouxy.plusone.commons.base.IWithCode; * * throw LoginException.Type.TOKEN_TIMEOUT.create(); *- * * * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/ParsingFailureException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/ParsingFailureException.java index 8948f3e..f716cb0 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/ParsingFailureException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/ParsingFailureException.java @@ -33,7 +33,6 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException.ExceptionType; ** throw new RequestParamsException(ParsingFailureException.of(ParsingFailureException.Type.NUMBER_PARSING_FAILURE)); *- * * * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/BizException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/BizException.java index 18549db..72edd38 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/BizException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/BizException.java @@ -21,11 +21,10 @@ package xyz.zhouxy.plusone.commons.exception.business; * ** 业务异常 - *
* ** NOTE: 通常表示业务中的意外情况。如:用户错误输入、缺失必填字段、用户余额不足等。 - *
+ * * @author ZhouXY * @since 1.0.0 */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/InvalidInputException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/InvalidInputException.java index bb25415..a5b095b 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/InvalidInputException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/InvalidInputException.java @@ -26,11 +26,10 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException; * ** 用户输入内容非法 - *
* ** NOTE: 属业务异常 - *
+ * * @author ZhouXY * @since 1.0.0 */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/RequestParamsException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/RequestParamsException.java index 9f39f7e..4a654f3 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/RequestParamsException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/RequestParamsException.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.exception.business; * ** 用户请求参数错误 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/package-info.java index f8da61b..851002c 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/package-info.java @@ -15,18 +15,17 @@ */ /** - *异常
+ *
异常
* *1. {@link MultiTypesException} - 多类型异常
** 异常在不同场景下被抛出,可以用不同的枚举值,表示不同的场景类型。 - *
+ * ** 异常实现 {@link MultiTypesException} 的 {@link MultiTypesException#getType} 方法,返回对应的场景类型。 - *
+ * ** 表示场景类型的枚举实现 {@link MultiTypesException.ExceptionType},其中的工厂方法用于创建对应类型的异常。 - *
* ** public final class LoginException @@ -57,7 +56,7 @@ * * // ... * - * public enum Type implements ExceptionType- * * * @author ZhouXY */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/gson/adapter/JSR310TypeAdapters.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/gson/adapter/JSR310TypeAdapters.java index 6130c95..427b98a 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/gson/adapter/JSR310TypeAdapters.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/gson/adapter/JSR310TypeAdapters.java @@ -164,7 +164,7 @@ public class JSR310TypeAdapters { * *{ + * public enum Type implements ExceptionType<LoginException> { * DEFAULT("00", "当前会话未登录"), * NOT_TOKEN("10", "未提供token"), * INVALID_TOKEN("20", "token无效"), @@ -113,7 +112,6 @@ * * throw LoginException.Type.TOKEN_TIMEOUT.create(); *- * * *2. 业务异常
* 预设常见的业务异常。可继承 {@link BizException} 自定义业务异常。 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/DataOperationResultException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/DataOperationResultException.java index 082620b..685df7b 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/DataOperationResultException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/DataOperationResultException.java @@ -21,13 +21,12 @@ package xyz.zhouxy.plusone.commons.exception.system; * ** 当数据操作的结果不符合预期时抛出。 - *
* ** 比如当一个 insert 或 update 操作时,预计影响数据库中的一行数据,但结果却影响了零条数据或多条数据, * 当出现这种始料未及的诡异情况时,抛出 {@link DataOperationResultException} 并回滚事务。 * 后续需要排查原因。 - *
+ * * @author ZhouXY * @since 1.0.0 */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/NoAvailableMacFoundException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/NoAvailableMacFoundException.java index c00a9d6..03b0747 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/NoAvailableMacFoundException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/NoAvailableMacFoundException.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.exception.system; * ** 在无法找到可访问的 Mac 地址时抛出 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/SysException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/SysException.java index 0848c05..690e6c5 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/SysException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/SysException.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.exception.system; * ** 通常表示应用代码存在问题,或因环境问题,引发异常。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/BoolUnaryOperator.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/BoolUnaryOperator.java index 4bca511..a12e708 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/BoolUnaryOperator.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/BoolUnaryOperator.java @@ -24,7 +24,6 @@ import com.google.common.annotations.Beta; ** 一个特殊的 {@link java.util.function.UnaryOperator}。 * 表示对 {@code boolean} 值的一元操作。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/CharUnaryOperator.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/CharUnaryOperator.java index 9a3db27..434e25a 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/CharUnaryOperator.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/CharUnaryOperator.java @@ -24,7 +24,6 @@ import com.google.common.annotations.Beta; ** 一个特殊的 {@link java.util.function.UnaryOperator}。 * 表示对 {@code char} 的一元操作。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/Executable.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/Executable.java index 3f3d933..107518e 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/Executable.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/Executable.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function; * ** 表示一个无入参无返回值的操作,可抛出异常。 - *
* * @param可抛出的异常类型 * diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/OptionalSupplier.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/OptionalSupplier.java index 97edeb6..8c0d645 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/OptionalSupplier.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/OptionalSupplier.java @@ -24,7 +24,6 @@ import java.util.function.Supplier; * * * 返回 {@code Optional<T>} 对象。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/PredicateTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/PredicateTools.java index e82118a..ef5cec5 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/PredicateTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/PredicateTools.java @@ -23,7 +23,6 @@ import java.util.function.Predicate; * ** {@link Predicate} 相关操作。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingConsumer.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingConsumer.java index e92e49f..c780211 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingConsumer.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingConsumer.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function; * ** 允许抛出异常的消费操作。是一个特殊的 {@link java.util.function.Consumer}。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingFunction.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingFunction.java index 4072715..734032e 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingFunction.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingFunction.java @@ -20,7 +20,6 @@ package xyz.zhouxy.plusone.commons.function; * ** 接收一个参数,并返回一个结果,可以抛出异常。 - *
* * @param入参类型 * @param 返回结果类型 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingPredicate.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingPredicate.java index cf650ce..c94a1ef 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingPredicate.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingPredicate.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function; * * * 接收一个参数,返回一个布尔值,可抛出异常。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingSupplier.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingSupplier.java index 8a3fa6d..65a8d99 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingSupplier.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ThrowingSupplier.java @@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function; * ** 允许抛出异常的 Supplier 接口。 - *
* * @param结果类型 * @param 异常类型 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/package-info.java index 458a666..1709cf1 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/package-info.java @@ -20,7 +20,6 @@ * 1. PredicateTools
** {@link PredicateTools} 用于 {@link java.util.function.Predicate} 的相关操作。 - *
* *2. Functional interfaces
*@@ -39,7 +38,6 @@ * | Optional | ToOptionalBiFunction | Optional<R> apply(T,U) | * | Optional | ToOptionalFunction | Optional<R> apply(T) | *
* 使用 {@link DateTimeFormatter#ISO_INSTANT} 进行 {@link Instant} 的序列化与反序列化。 - *
+ * */ public static final class InstantTypeAdapter extends TypeAdapter{ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Chinese2ndGenIDCardNumber.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Chinese2ndGenIDCardNumber.java index c8be438..e925fed 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Chinese2ndGenIDCardNumber.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Chinese2ndGenIDCardNumber.java @@ -40,7 +40,6 @@ import xyz.zhouxy.plusone.commons.util.StringTools; * * * 中国第二代居民身份证号 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingAndSortingQueryParams.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingAndSortingQueryParams.java index 74c2434..e86c277 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingAndSortingQueryParams.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingAndSortingQueryParams.java @@ -37,7 +37,6 @@ import xyz.zhouxy.plusone.commons.util.StringTools; ** 根据传入的 {@code size} 和 {@code pageNum}, * 提供 {@code getOffset} 方法计算 SQL 语句中 {@code offset} 的值。 - *
* * @author ZhouXY * @see PagingParams diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/package-info.java index 0296dc2..ebd2384 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/package-info.java @@ -22,12 +22,12 @@ * 分页组件由 {@link PagingAndSortingQueryParams} 作为入参, * 因为分页必须伴随着排序,不然可能出现同一个对象重复出现在不同页,有的对象不被查询到的情况, * 所以分页查询的入参必须包含排序条件。 - * + * ** 用户可继承 {@link PagingAndSortingQueryParams} * 构建自己的分页查询入参,需在构造器中调用 {@link PagingAndSortingQueryParams} 的构造器,传入一个 Map 作为白名单, * key 是供前端指定用于排序的属性名,value 是对应数据库中的字段名,只有在白名单中指定的属性名才允许作为排序条件。 - *
+ * ** {@link PagingAndSortingQueryParams} 包含三个主要的属性: *
@@ -37,21 +37,20 @@ *
* 其中 orderBy 是一个 List,可以指定多个排序条件,每个排序条件是一个字符串, * 格式为“属性名-ASC”或“属性名-DESC”,分别表示升序和降序。 - * + * ** 比如前端传入的 orderBy 为 ["name-ASC","age-DESC"],意味着要按 name 进行升序,name 相同的情况下则按 age 进行降序。 - *
+ * ** 使用时调用 {@link PagingAndSortingQueryParams#buildPagingParams()} 方法获取分页参数 {@link PagingParams}。 - *
+ * ** 分页结果可以存放到 {@link PageResult} 中,作为出参。 - *
* *2. {@link UnifiedResponse}
** {@link UnifiedResponse} 对返回给前端的数据进行封装,包含 code、message、data。 - *
+ * ** 可使用 {@link UnifiedResponses} 快速构建 {@link UnifiedResponse} 对象。 * {@link UnifiedResponses} 默认的成功代码为 "2000000", @@ -60,7 +59,6 @@ * 中所示范的,继承 {@link UnifiedResponses} 实现自己的工厂类, * 自定义 SUCCESS_CODE 和 DEFAULT_SUCCESS_MSG 和工厂方法。 * 见 issue#22。 - *
* * @author ZhouXY */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/package-info.java index c3f1fb6..4f73c10 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/package-info.java @@ -18,7 +18,6 @@ *业务建模组件
** 包含业务建模可能用到的性别、身份证等元素,也包含 DTO 相关类,如分页查询参数,响应结果,分页结果等。 - *
* * @author ZhouXY */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/package-info.java index 78358d4..edb01ff 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/package-info.java @@ -15,7 +15,7 @@ */ /** - *时间 API
+ *
时间 API
* *1. 季度 API
* diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ArrayTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ArrayTools.java index cb4b54b..6f953a7 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ArrayTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ArrayTools.java @@ -33,7 +33,6 @@ import javax.annotation.Nullable; * ** 数组工具类 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/AssertTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/AssertTools.java index cfb4121..268e764 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/AssertTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/AssertTools.java @@ -29,7 +29,6 @@ import xyz.zhouxy.plusone.commons.exception.system.DataOperationResultException; * ** 本工具类不封装过多判断逻辑,鼓励充分使用项目中的工具类进行逻辑判断。 - *
* ** AssertTools.checkArgument(StringUtils.hasText(str), "The argument cannot be blank."); diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/BigDecimals.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/BigDecimals.java index 26b512e..e3439f4 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/BigDecimals.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/BigDecimals.java @@ -28,7 +28,6 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod; * ** BigDecimal 工具类 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/DateTimeTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/DateTimeTools.java index 9e0dd95..d0fc3f6 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/DateTimeTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/DateTimeTools.java @@ -215,7 +215,6 @@ public class DateTimeTools { ** 传入不同 {@link ZoneId},获取到的 {@link ZonedDateTime} 对象实际上还是同一时间戳, * 只是不同时区的表示。 - *
* * @param timeMillis 时间戳 * @param zone 时区 @@ -230,7 +229,6 @@ public class DateTimeTools { ** 传入不同 {@link ZoneId},获取到的 {@link ZonedDateTime} 对象实际上还是同一时间戳, * 只是不同时区的表示。 - *
* * @param dateTime {@link Date} 对象 * @param zone 时区 @@ -245,7 +243,6 @@ public class DateTimeTools { ** 传入不同 {@link ZoneId},获取到的 {@link ZonedDateTime} 对象实际上表示的还是还是同一时间戳的时间, * 只是不同时区的表示。 - *
* * @param dateTime {@link Date} 对象 * @param timeZone 时区 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java index 49288b6..ffef722 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Enumeration.java @@ -34,7 +34,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod; * 参考 Enumeration classes * * @author ZhouXY - * @deprecated 设计 Enumeration 的灵感来自于 .net 社区,因为 C# 的枚举不带行为。 + * @deprecated 设计 Enumeration 的灵感来自于 .net 社区,因为 C# 的枚举不带行为。 * 但 Java 的枚举可以带行为,故大多数情况下不需要这种设计。 */ @Deprecated diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdGenerator.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdGenerator.java index 0d846c2..fd90391 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdGenerator.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdGenerator.java @@ -26,7 +26,6 @@ import java.util.concurrent.ConcurrentHashMap; * ** 生成 UUID 和 修改版雪花ID(Seata 版本) - *
* * @see UUID * @see IdWorker diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdWorker.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdWorker.java index ad884f7..6816793 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdWorker.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/IdWorker.java @@ -34,7 +34,7 @@ import xyz.zhouxy.plusone.commons.exception.system.NoAvailableMacFoundException; *每个机器线程安全地生成序列,前面加上机器的id,这样就不会与其它机器的id相冲突。 *时间戳作为序列的“预留位”,它更像是应用启动时最开始的序列的一部分,在一个时间戳里生成 4096 个 id 之后,直接生成下一个时间戳的 id。 * - * + * ** 详情见以下介绍: *
@@ -43,7 +43,7 @@ import xyz.zhouxy.plusone.commons.exception.system.NoAvailableMacFoundException; *
- * + * */ public class IdWorker { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/OptionalTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/OptionalTools.java index 50b7a83..18dd47f 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/OptionalTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/OptionalTools.java @@ -45,7 +45,6 @@ public class OptionalTools { *- 在开源项目中看到一个改良版的雪花算法,现在它是你的了。
*- 关于若干读者,阅读“改良版雪花算法”后提出的几个共性问题的回复。
** 包装类为 {@code null} 表示值的缺失,转为 {@link OptionalInt} 后,由 * {@link OptionalInt#empty()} 表示值的缺失。 - *
* * @param value 包装对象 * @return {@link OptionalInt} 实例 @@ -58,7 +57,6 @@ public class OptionalTools { * 将 {@code Optional} 对象转为 {@link OptionalInt} 对象。 * * {@code Optional
* * @param optionalObj {@code Optional} 将整数包装了两次,改为使用 {@link OptionalInt} 包装其中的整数数据。 - * } 对象 * @return {@link OptionalInt} 实例 @@ -72,7 +70,6 @@ public class OptionalTools { * * 包装类为 {@code null} 表示值的缺失,转为 {@link OptionalLong} 后,由 * {@link OptionalLong#empty()} 表示值的缺失。 - *
* * @param value 包装对象 * @return {@link OptionalLong} 实例 @@ -85,7 +82,6 @@ public class OptionalTools { * 将 {@code Optional} 转为 {@link OptionalLong}。 * * {@code Optional
* * @param optionalObj 包装对象 * @return {@link OptionalLong} 实例 @@ -99,7 +95,6 @@ public class OptionalTools { *} 将整数包装了两次,改为使用 {@link OptionalLong} 包装其中的整数数据。 - * * 包装类为 {@code null} 表示值的缺失,转为 {@link OptionalDouble} 后,由 * {@link OptionalDouble#empty()} 表示值的缺失。 - *
* * @param value 包装对象 * @return {@link OptionalDouble} 实例 @@ -112,7 +107,6 @@ public class OptionalTools { * 将 {@code Optional} 转为 {@link OptionalDouble}。 * * {@code Optional
* * @param optionalObj 包装对象 * @return {@link OptionalDouble} 实例 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RandomTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RandomTools.java index 0100b1a..1f7ca35 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RandomTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RandomTools.java @@ -26,7 +26,7 @@ import java.util.concurrent.ThreadLocalRandom; * 随机工具类 *} 将整数包装了两次,改为使用 {@link OptionalDouble} 包装其中的整数数据。 - * * 建议调用方自行维护 Random 对象 - *
+ * * @author ZhouXY */ public final class RandomTools { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/StringTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/StringTools.java index cf1aec7..0a523d5 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/StringTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/StringTools.java @@ -31,7 +31,6 @@ import xyz.zhouxy.plusone.commons.constant.PatternConsts; * ** 字符串工具类。 - *
* * @author ZhouXY * @since 1.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/package-info.java index ed29202..f93b3c1 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/package-info.java @@ -18,7 +18,6 @@ *工具类
** 包含树构建器({@link TreeBuilder})、断言工具({@link AssertTools})、ID 生成器({@link IdGenerator})及其它实用工具类。 - *
* * @author ZhouXY */