From 1b7e0f5a40445ff3a22128908cb43be4c1a1f4eb Mon Sep 17 00:00:00 2001 From: ZhouXY108 Date: Thu, 28 May 2026 21:51:39 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E4=BD=9C=E8=80=85?= =?UTF-8?q?=E4=BF=A1=E6=81=AF=E5=B9=B6=E5=AE=8C=E5=96=84Javadoc=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../zhouxy/plusone/commons/annotation/ReaderMethod.java | 2 +- .../plusone/commons/annotation/StaticFactoryMethod.java | 2 +- .../plusone/commons/annotation/UnsupportedOperation.java | 2 +- .../zhouxy/plusone/commons/annotation/ValueObject.java | 2 +- .../xyz/zhouxy/plusone/commons/annotation/Virtual.java | 2 +- .../zhouxy/plusone/commons/annotation/WriterMethod.java | 2 +- .../zhouxy/plusone/commons/annotation/package-info.java | 2 +- .../java/xyz/zhouxy/plusone/commons/base/IWithCode.java | 2 +- .../xyz/zhouxy/plusone/commons/base/IWithIntCode.java | 2 +- .../xyz/zhouxy/plusone/commons/base/IWithLongCode.java | 2 +- .../xyz/zhouxy/plusone/commons/base/package-info.java | 2 +- .../plusone/commons/collection/CollectionTools.java | 2 +- .../zhouxy/plusone/commons/collection/MapModifier.java | 4 +++- .../zhouxy/plusone/commons/collection/package-info.java | 2 +- .../zhouxy/plusone/commons/constant/PatternConsts.java | 2 +- .../xyz/zhouxy/plusone/commons/constant/RegexConsts.java | 2 +- .../zhouxy/plusone/commons/constant/package-info.java | 2 +- .../commons/exception/DataNotExistsException.java | 2 +- .../plusone/commons/exception/IExceptionFactory.java | 2 +- .../zhouxy/plusone/commons/exception/IExceptionType.java | 4 +++- .../plusone/commons/exception/IMultiTypesException.java | 2 +- .../commons/exception/ParsingFailureException.java | 2 +- .../plusone/commons/exception/business/BizException.java | 2 +- .../exception/business/InvalidInputException.java | 2 +- .../exception/business/RequestParamsException.java | 2 +- .../plusone/commons/exception/business/package-info.java | 2 +- .../zhouxy/plusone/commons/exception/package-info.java | 2 +- ...JdbcUpdateAffectedIncorrectNumberOfRowsException.java | 2 +- .../exception/system/NoAvailableMacFoundException.java | 2 +- .../plusone/commons/exception/system/SysException.java | 2 +- .../plusone/commons/exception/system/package-info.java | 2 +- .../plusone/commons/function/BoolUnaryOperator.java | 2 +- .../plusone/commons/function/CharUnaryOperator.java | 2 +- .../xyz/zhouxy/plusone/commons/function/Executable.java | 2 +- .../plusone/commons/function/OptionalSupplier.java | 2 +- .../zhouxy/plusone/commons/function/PredicateTools.java | 2 +- .../plusone/commons/function/ThrowingConsumer.java | 3 ++- .../plusone/commons/function/ThrowingFunction.java | 3 ++- .../plusone/commons/function/ThrowingPredicate.java | 3 ++- .../plusone/commons/function/ThrowingSupplier.java | 3 ++- .../plusone/commons/function/ToOptionalBiFunction.java | 2 +- .../plusone/commons/function/ToOptionalFunction.java | 2 +- .../zhouxy/plusone/commons/function/package-info.java | 2 +- .../plusone/commons/gson/adapter/JSR310TypeAdapters.java | 2 +- .../plusone/commons/model/Chinese2ndGenIDCardNumber.java | 2 +- .../java/xyz/zhouxy/plusone/commons/model/Gender.java | 2 +- .../xyz/zhouxy/plusone/commons/model/IDCardNumber.java | 2 +- .../java/xyz/zhouxy/plusone/commons/model/SemVer.java | 2 +- .../plusone/commons/model/ValidatableStringRecord.java | 2 +- .../xyz/zhouxy/plusone/commons/model/dto/PageResult.java | 2 +- .../commons/model/dto/PagingAndSortingQueryParams.java | 2 +- .../zhouxy/plusone/commons/model/dto/PagingParams.java | 2 +- .../plusone/commons/model/dto/UnifiedResponse.java | 2 +- .../plusone/commons/model/dto/UnifiedResponses.java | 6 +++++- .../zhouxy/plusone/commons/model/dto/package-info.java | 2 +- .../xyz/zhouxy/plusone/commons/model/package-info.java | 2 +- .../java/xyz/zhouxy/plusone/commons/time/Quarter.java | 2 +- .../xyz/zhouxy/plusone/commons/time/YearQuarter.java | 2 +- .../xyz/zhouxy/plusone/commons/time/package-info.java | 2 +- .../java/xyz/zhouxy/plusone/commons/util/ArrayTools.java | 4 +++- .../xyz/zhouxy/plusone/commons/util/AssertTools.java | 8 ++++++-- .../xyz/zhouxy/plusone/commons/util/BigDecimals.java | 2 +- .../xyz/zhouxy/plusone/commons/util/DateTimeTools.java | 5 +++-- .../java/xyz/zhouxy/plusone/commons/util/EnumTools.java | 9 +++++---- .../xyz/zhouxy/plusone/commons/util/Enumeration.java | 4 ++-- .../xyz/zhouxy/plusone/commons/util/IdGenerator.java | 2 +- .../xyz/zhouxy/plusone/commons/util/JodaTimeTools.java | 2 +- .../java/xyz/zhouxy/plusone/commons/util/Numbers.java | 2 +- .../xyz/zhouxy/plusone/commons/util/OptionalTools.java | 2 +- .../xyz/zhouxy/plusone/commons/util/RandomTools.java | 4 +++- .../main/java/xyz/zhouxy/plusone/commons/util/Ref.java | 4 ++-- .../java/xyz/zhouxy/plusone/commons/util/RegexTools.java | 2 +- .../xyz/zhouxy/plusone/commons/util/StringTools.java | 2 +- .../xyz/zhouxy/plusone/commons/util/TreeBuilder.java | 4 +++- .../java/xyz/zhouxy/plusone/commons/util/ZipTools.java | 3 +-- .../xyz/zhouxy/plusone/commons/util/package-info.java | 2 +- .../model/dto/test/PagingAndSortingQueryParamsTests.java | 2 +- 77 files changed, 108 insertions(+), 85 deletions(-) diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ReaderMethod.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ReaderMethod.java index 4ef1848..eab2f20 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ReaderMethod.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ReaderMethod.java @@ -27,7 +27,7 @@ import java.lang.annotation.Target; *

* 标识方法是读方法，如 getter。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see WriterMethod */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/StaticFactoryMethod.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/StaticFactoryMethod.java index d105b48..609c25b 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/StaticFactoryMethod.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/StaticFactoryMethod.java @@ -26,7 +26,7 @@ import java.lang.annotation.Target; * *

标识方法为静态工厂方法 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ @Target(ElementType.METHOD) diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/UnsupportedOperation.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/UnsupportedOperation.java index 33d752a..a87ee32 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/UnsupportedOperation.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/UnsupportedOperation.java @@ -27,7 +27,7 @@ import java.lang.annotation.Documented; * *

标识方法为不支持的操作。该方法将抛出 {@link UnsupportedOperationException}。 * - * @author ZhouXY108 + * @author ZhouXY * @version 1.0 * @since 1.0.0 * @see UnsupportedOperationException diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ValueObject.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ValueObject.java index d427c8b..9907290 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ValueObject.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/ValueObject.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; /** * ValueObject - 值对象 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ @Inherited diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/Virtual.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/Virtual.java index 5f2bc0e..6053088 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/Virtual.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/Virtual.java @@ -25,7 +25,7 @@ import java.lang.annotation.Target; * 标识该方法是虚方法。 *

该注解用于提醒、强调父类虽然有默认实现，但子类可以根据自己的需要覆写。

* - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ @Target(ElementType.METHOD) diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/WriterMethod.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/WriterMethod.java index fe592a8..32106c5 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/WriterMethod.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/annotation/WriterMethod.java @@ -27,7 +27,7 @@ import java.lang.annotation.Target; *

* 标识方法是写方法，如 setter。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see ReaderMethod */ 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 fab35ea..cd1ce3f 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 @@ -17,6 +17,6 @@ /** * 注解 * - * @author ZhouXY108 + * @author ZhouXY */ package xyz.zhouxy.plusone.commons.annotation; diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithCode.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithCode.java index 91791b9..c0e0928 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithCode.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithCode.java @@ -26,7 +26,7 @@ import javax.annotation.Nullable; * 用于像自定义异常等需要带有 {@code code} 字段的类， * 方便其它地方的程序判断该类的是否实现了此接口，以此获取其实例的 {@code code} 字段的值。 * - * @author ZhouXY108 + * @author ZhouXY */ public interface IWithCode { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithIntCode.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithIntCode.java index 06efffa..759ac55 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithIntCode.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithIntCode.java @@ -25,7 +25,7 @@ import javax.annotation.Nullable; * 用于像自定义异常等需要带有 {@code code} 字段的类， * 方便其它地方的程序判断该类的是否实现了此接口，以此获取其实例的 {@code code} 字段的值。 * - * @author ZhouXY108 + * @author ZhouXY */ public interface IWithIntCode { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithLongCode.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithLongCode.java index de06658..912a719 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithLongCode.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/base/IWithLongCode.java @@ -25,7 +25,7 @@ import javax.annotation.Nullable; * 用于像自定义异常等需要带有 {@code code} 字段的类， * 方便其它地方的程序判断该类的是否实现了此接口，以此获取其实例的 {@code code} 字段的值。 * - * @author ZhouXY108 + * @author ZhouXY */ public interface IWithLongCode { 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 82fdfc4..2caa1c9 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 @@ -17,7 +17,7 @@ /** * 基础内容 * - * @author ZhouXY108 + * @author ZhouXY */ @CheckReturnValue @ParametersAreNonnullByDefault diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/CollectionTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/CollectionTools.java index 4ac2b9e..3f4b46d 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/CollectionTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/CollectionTools.java @@ -33,7 +33,7 @@ import com.google.common.collect.Table; /** * 集合工具类 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class CollectionTools { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/MapModifier.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/MapModifier.java index b960718..5df1f6f 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/MapModifier.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/collection/MapModifier.java @@ -73,7 +73,7 @@ import com.google.common.annotations.Beta; * .getAndModify(HashMap::new); * * - * @author ZhouXY108 + * @author ZhouXY * @since 1.1.0 */ @Beta @@ -202,6 +202,7 @@ public class MapModifier { * 修改 {@code map} * * @param map 要修改的 {@code map} + * @param {@code map} 的类型 */ public > void modify(@Nullable T map) { if (map == null || this.operations.isEmpty()) { @@ -214,6 +215,7 @@ public class MapModifier { * 修改 {@code map} * * @param mapSupplier {@code map} 的 {@link Supplier} + * @param {@code map} 的类型 * @return 修改后的 {@code map}。 * 当从 {@code mapSupplier} 获取的 {@code map} 为 {@code null} 时，返回 {@code null}。 */ 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 08b2886..7f1fca5 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 @@ -17,7 +17,7 @@ /** * 集合相关工具 * - * @author ZhouXY108 + * @author ZhouXY */ @ParametersAreNonnullByDefault package xyz.zhouxy.plusone.commons.collection; 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 c0b0e08..5f0f8c7 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 @@ -21,7 +21,7 @@ import java.util.regex.Pattern; /** * 正则表达式常量 * - * @author ZhouXY108 + * @author ZhouXY * @see RegexConsts * @see xyz.zhouxy.plusone.commons.util.RegexTools */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/RegexConsts.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/RegexConsts.java index 29edc50..67c13e3 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/RegexConsts.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/constant/RegexConsts.java @@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.constant; /** * 正则表达式常量 * - * @author ZhouXY108 + * @author ZhouXY * @see PatternConsts */ public final class RegexConsts { 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 4427cd0..2fef3c4 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 @@ -22,7 +22,7 @@ * * {@link RegexConsts} 包含常见正则表达式；{@link PatternConsts} 包含对应的 {@link Pattern} 对象。 * - * @author ZhouXY108 + * @author ZhouXY */ package xyz.zhouxy.plusone.commons.constant; diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/DataNotExistsException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/DataNotExistsException.java index a5668ab..6c03458 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/DataNotExistsException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/DataNotExistsException.java @@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.exception; /** * 数据不存在异常 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public final class DataNotExistsException extends Exception { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionFactory.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionFactory.java index 161541a..8fbfe35 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionFactory.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionFactory.java @@ -21,7 +21,7 @@ import javax.annotation.Nonnull; * 异常工厂 * * @param 异常类型 - * @author ZhouXY108 + * @author ZhouXY */ public interface IExceptionFactory { /** diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionType.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionType.java index fa1de5d..7ccde15 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionType.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IExceptionType.java @@ -22,12 +22,14 @@ import xyz.zhouxy.plusone.commons.base.IWithCode; * 异常场景 * * @param 场景编码 - * @author ZhouXY108 + * @author ZhouXY */ public interface IExceptionType extends IWithCode { /** * 默认异常信息 + * + * @return 默认异常信息 */ String getDefaultMessage(); diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IMultiTypesException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IMultiTypesException.java index 3e7c75d..db5a4e7 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IMultiTypesException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/IMultiTypesException.java @@ -118,7 +118,7 @@ import javax.annotation.Nonnull; * * * @param 异常场景 - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public interface IMultiTypesException> { 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 493b084..9225bf7 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,7 @@ import xyz.zhouxy.plusone.commons.exception.business.RequestParamsException; * throw new RequestParamsException(ParsingFailureException.Type.NUMBER_PARSING_FAILURE.create()); * * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public final class ParsingFailureException 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 169ed19..d80553b 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 @@ -25,7 +25,7 @@ package xyz.zhouxy.plusone.commons.exception.business; *

* NOTE: 通常表示业务中的意外情况。如：用户错误输入、缺失必填字段、用户余额不足等。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class BizException extends RuntimeException { 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 11ae100..44ad86f 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 @@ -31,7 +31,7 @@ import xyz.zhouxy.plusone.commons.exception.IMultiTypesException; *

* NOTE: 属业务异常 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public final class InvalidInputException 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 4dc364a..5b6cadf 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 @@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.exception.business; *

* 用户请求参数错误 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class RequestParamsException extends BizException { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/package-info.java index fb99934..75bcfd4 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/business/package-info.java @@ -17,6 +17,6 @@ /** * 业务异常 * - * @author ZhouXY108 + * @author ZhouXY */ package xyz.zhouxy.plusone.commons.exception.business; 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 3b5a202..da86b2d 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 @@ -17,6 +17,6 @@ /** * 包含常见的业务异常与系统异常，以及异常相关的工具 * - * @author ZhouXY108 + * @author ZhouXY */ package xyz.zhouxy.plusone.commons.exception; diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/JdbcUpdateAffectedIncorrectNumberOfRowsException.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/JdbcUpdateAffectedIncorrectNumberOfRowsException.java index 764862c..a695810 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/JdbcUpdateAffectedIncorrectNumberOfRowsException.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/JdbcUpdateAffectedIncorrectNumberOfRowsException.java @@ -31,7 +31,7 @@ import javax.annotation.Nullable; * 当出现这种始料未及的诡异情况时，抛出 {@link JdbcUpdateAffectedIncorrectNumberOfRowsException} 并回滚事务。 * 后续需要排查原因。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public final class JdbcUpdateAffectedIncorrectNumberOfRowsException extends SysException { 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 fac84e5..076e455 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 @@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.exception.system; *

* 在无法找到可访问的 Mac 地址时抛出 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class NoAvailableMacFoundException extends SysException { 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 09930c3..61892c5 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 @@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.exception.system; *

* 通常表示应用代码存在问题，或因环境问题，引发异常。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class SysException extends RuntimeException { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/package-info.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/package-info.java index af219f1..7c71ffa 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/package-info.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/exception/system/package-info.java @@ -17,6 +17,6 @@ /** * 系统异常 * - * @author ZhouXY108 + * @author ZhouXY */ package xyz.zhouxy.plusone.commons.exception.system; 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 8ca3f38..bb21552 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 @@ -25,7 +25,7 @@ import com.google.common.annotations.Beta; * 一个特殊的 {@link java.util.function.UnaryOperator}。 * 表示对 {@code boolean} 值的一元操作。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see java.util.function.UnaryOperator */ 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 4a40031..4f34895 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 @@ -25,7 +25,7 @@ import com.google.common.annotations.Beta; * 一个特殊的 {@link java.util.function.UnaryOperator}。 * 表示对 {@code char} 的一元操作。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see java.util.function.UnaryOperator */ 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 b8f1220..35065a9 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 @@ -24,7 +24,7 @@ package xyz.zhouxy.plusone.commons.function; * * @param 可抛出的异常类型 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ @FunctionalInterface 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 432d6a9..d9f5ce1 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 @@ -25,7 +25,7 @@ import java.util.function.Supplier; *

* 返回 {@code Optional<T>} 对象。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see Optional * @see Supplier 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 3f86070..625a757 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 @@ -24,7 +24,7 @@ import java.util.function.Predicate; *

* {@link Predicate} 相关操作。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see Predicate */ 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 6e6fb0c..4f0d2af 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 @@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.function; *

* 允许抛出异常的消费操作。是一个特殊的 {@link java.util.function.Consumer}。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see java.util.function.Consumer */ @@ -33,6 +33,7 @@ public interface ThrowingConsumer { * 消费给定的参数，允许抛出异常 * * @param t 要消费的参数 + * @throws E 抛出的异常 */ void accept(T t) throws E; 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 93fec3e..195a44d 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 @@ -25,7 +25,7 @@ package xyz.zhouxy.plusone.commons.function; * @param 返回结果类型 * @param 异常类型 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0 * @see java.util.function.Function */ @@ -37,6 +37,7 @@ public interface ThrowingFunction { * * @param t 入参 * @return 函数结果 + * @throws E 抛出的异常 */ R apply(T t) throws E; 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 bd5e77f..96b8349 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 @@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.function; *

* 接收一个参数，返回一个布尔值，可抛出异常。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see java.util.function.Predicate */ @@ -34,6 +34,7 @@ public interface ThrowingPredicate { * * @param t 入参 * @return 入参符合条件时返回 {@code true}，否则返回 {@code false} + * @throws E 抛出的异常 */ boolean test(T t) throws E; } 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 ac5d4cd..3f88a68 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 @@ -25,7 +25,7 @@ package xyz.zhouxy.plusone.commons.function; * @param 结果类型 * @param 异常类型 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see java.util.function.Supplier */ @@ -36,6 +36,7 @@ public interface ThrowingSupplier { * 获取一个结果，允许抛出异常。 * * @return 结果 + * @throws E 允许抛出的异常 */ T get() throws E; diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalBiFunction.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalBiFunction.java index 348a5c7..14e825a 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalBiFunction.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalBiFunction.java @@ -25,7 +25,7 @@ import java.util.function.BiFunction; *

* 接受类型为 T 和 U 的两个参数，返回 {@code Optional<R>} 对象。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see Optional * @see BiFunction diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalFunction.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalFunction.java index 485e146..145924f 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalFunction.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/function/ToOptionalFunction.java @@ -25,7 +25,7 @@ import java.util.function.Function; *

* 接受类型为 T 的参数，返回 {@code Optional<R>} 对象。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see Optional * @see Function 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 92a6b45..e35ada4 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 @@ -39,6 +39,6 @@ * | Optional | ToOptionalFunction | Optional<R> apply(T) | * * - * @author ZhouXY108 + * @author ZhouXY */ package xyz.zhouxy.plusone.commons.function; 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 34c8c38..fb6911b 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 @@ -33,7 +33,7 @@ import com.google.gson.stream.JsonWriter; /** * 包含 JSR-310 相关数据类型的 {@code TypeAdapter} * - * @author ZhouXY108 + * @author ZhouXY * @since 1.1.0 * @see TypeAdapter * @see com.google.gson.GsonBuilder 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 fdb83a6..5ed2749 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 @@ -42,7 +42,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools; *

* 中国第二代居民身份证号 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see xyz.zhouxy.plusone.commons.constant.PatternConsts#CHINESE_2ND_ID_CARD_NUMBER */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Gender.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Gender.java index abf4f19..8503a28 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Gender.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/Gender.java @@ -23,7 +23,7 @@ import xyz.zhouxy.plusone.commons.base.IWithIntCode; /** * 性别 * - * @author ZhouXY108 + * @author ZhouXY */ public enum Gender implements IWithIntCode { UNKNOWN(0, "Unknown", "未知"), diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/IDCardNumber.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/IDCardNumber.java index cfc4ad9..6bc6133 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/IDCardNumber.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/IDCardNumber.java @@ -24,7 +24,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools; /** * 身份证号 * - * @author ZhouXY108 + * @author ZhouXY */ public interface IDCardNumber { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/SemVer.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/SemVer.java index eb86de8..71e65bd 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/SemVer.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/SemVer.java @@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools; /** * SemVer 语义版本号 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.1.0 * * @see Semantic Versioning 2.0.0 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/ValidatableStringRecord.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/ValidatableStringRecord.java index dc4dc7a..41e4278 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/ValidatableStringRecord.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/ValidatableStringRecord.java @@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.annotation.ReaderMethod; /** * 带校验的字符串值对象 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * * @deprecated 弃用。使用工厂方法创建对象，并在其中进行校验即可。 diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PageResult.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PageResult.java index 90a51da..c9e54b1 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PageResult.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PageResult.java @@ -29,7 +29,7 @@ import xyz.zhouxy.plusone.commons.collection.CollectionTools; * * @param 内容列表的元素类型 * - * @author ZhouXY108 + * @author ZhouXY * @see PagingAndSortingQueryParams */ public class PageResult { 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 73e2170..84e90d8 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 @@ -94,7 +94,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools; * } * * - * @author ZhouXY108 + * @author ZhouXY * @see PagingParams * @see PageResult */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingParams.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingParams.java index f008999..bd7ef06 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingParams.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/PagingParams.java @@ -24,7 +24,7 @@ import xyz.zhouxy.plusone.commons.model.dto.PagingAndSortingQueryParams.Sortable /** * 分页参数 * - * @author ZhouXY108 + * @author ZhouXY * @see PagingAndSortingQueryParams */ public class PagingParams { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponse.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponse.java index 9410ae8..5775cf6 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponse.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponse.java @@ -22,7 +22,7 @@ import javax.annotation.Nullable; /** * 统一结果，对返回给前端的数据进行封装。 * - * @author ZhouXY108 + * @author ZhouXY */ public class UnifiedResponse { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponses.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponses.java index e039da1..3bfa8ff 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponses.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/model/dto/UnifiedResponses.java @@ -54,7 +54,7 @@ import javax.annotation.Nullable; * * 见 issue#22。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see UnifiedResponse */ @@ -70,6 +70,7 @@ public class UnifiedResponses { /** * 默认成功响应结果 * + * @param data 类型 * @return {@code UnifiedResponse} 对象。 * {@code code} = "2000000", {@code message} = "SUCCESS", {@code data} = null */ @@ -81,6 +82,7 @@ public class UnifiedResponses { * 使用指定 {@code message} 创建成功响应结果 * * @param message 成功信息 + * @param data 类型 * @return {@code UnifiedResponse} 对象。 * {@code code} = "2000000", {@code data} = null */ @@ -114,6 +116,7 @@ public class UnifiedResponses { * * @param code 错误码 * @param message 错误信息 + * @param data 类型 * @return {@code UnifiedResponse} 对象（{@code data} 为 {@code null}） */ public static UnifiedResponse error(String code, @Nullable String message) { @@ -159,6 +162,7 @@ public class UnifiedResponses { * * @param code 状态码 * @param message 响应信息 + * @param data 类型 * @return {@code UnifiedResponse} 对象（{@code data} 为 {@code null}） */ public static UnifiedResponse of(String code, @Nullable String message) { 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 78caded..c9cecd8 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 @@ -58,7 +58,7 @@ * 用户可以继承 {@link UnifiedResponses} 实现自己的工厂类， * 自定义 SUCCESS_CODE 和 DEFAULT_SUCCESS_MSG，以及工厂方法。 * - * @author ZhouXY108 + * @author ZhouXY */ @ParametersAreNonnullByDefault package xyz.zhouxy.plusone.commons.model.dto; 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 cc9d7cd..25dced1 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 @@ -19,7 +19,7 @@ *

* 包含业务建模可能用到的性别、身份证等元素，也包含 DTO 相关类，如分页查询参数，响应结果，分页结果等。 * - * @author ZhouXY108 + * @author ZhouXY */ @ParametersAreNonnullByDefault package xyz.zhouxy.plusone.commons.model; diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/Quarter.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/Quarter.java index d61682b..a73219a 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/Quarter.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/Quarter.java @@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.base.IWithIntCode; /** * 季度 * - * @author ZhouXY108 + * @author ZhouXY */ public enum Quarter implements IWithIntCode { /** 第一季度 */ diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/YearQuarter.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/YearQuarter.java index 88b2ccc..652a606 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/YearQuarter.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/time/YearQuarter.java @@ -39,7 +39,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod; /** * 表示年份与季度 * - * @author ZhouXY108 + * @author ZhouXY */ @Immutable public final class YearQuarter implements Comparable, Serializable { 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 5f6b6a4..95ca6b3 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 @@ -22,7 +22,7 @@ * 模仿 JDK 的 {@link java.time.Month} 和 {@link java.time.YearMonth}， * 实现 {@link Quarter}，{@link YearQuarter}，对季度进行建模。 * - * @author ZhouXY108 + * @author ZhouXY */ @ParametersAreNonnullByDefault package xyz.zhouxy.plusone.commons.time; 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 ab1f89c..0c2056b 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 @@ -38,7 +38,7 @@ import javax.annotation.Nullable; *

* 数组工具类 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class ArrayTools { @@ -1038,6 +1038,7 @@ public class ArrayTools { * * @param a 要填充的数组 * @param values 填充内容 + * @param 元素类型 */ public static void fill(T[] a, @Nullable T[] values) { fillInternal(a, 0, a.length, values); @@ -1050,6 +1051,7 @@ public class ArrayTools { * @param fromIndex 开始位置 * @param toIndex 结束位置 * @param values 填充内容 + * @param 元素类型 */ public static void fill(T[] a, int fromIndex, int toIndex, @Nullable T[] values) { fillInternal(a, fromIndex, toIndex, values); 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 d29b3d4..420dc5c 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 @@ -33,12 +33,12 @@ import xyz.zhouxy.plusone.commons.exception.DataNotExistsException; * checkArgument(StringUtils.hasText(str), "The argument cannot be blank."); * checkState(ArrayUtils.isNotEmpty(result), "The result cannot be empty."); * checkCondition(!CollectionUtils.isEmpty(roles), - * () -> new InvalidInputException("The roles cannot be empty.")); + * () -> new InvalidInputException("The roles cannot be empty.")); * checkCondition(RegexTools.matches(email, PatternConsts.EMAIL), * "must be a well-formed email address"); * * - * @author ZhouXY108 + * @author ZhouXY */ public class AssertTools { @@ -112,6 +112,7 @@ public class AssertTools { * * @param 入参类型 * @param obj 入参 + * @return 校验通过时返回入参 * @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出 */ public static T checkArgumentNotNull(@Nullable T obj) { @@ -127,6 +128,7 @@ public class AssertTools { * @param 入参类型 * @param obj 入参 * @param errorMessage 异常信息 + * @return 校验通过时返回入参 * @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出 */ public static T checkArgumentNotNull(@Nullable T obj, String errorMessage) { @@ -142,6 +144,7 @@ public class AssertTools { * @param 入参类型 * @param obj 入参 * @param errorMessageSupplier 异常信息 + * @return 校验通过时返回入参 * @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出 */ public static T checkArgumentNotNull(@Nullable T obj, Supplier errorMessageSupplier) { @@ -158,6 +161,7 @@ public class AssertTools { * @param obj 入参 * @param errorMessageTemplate 异常信息模板 * @param errorMessageArgs 异常信息参数 + * @return 校验通过时返回入参 * @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出 */ public static T checkArgumentNotNull(@Nullable T obj, 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 3b37299..99feb01 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 @@ -31,7 +31,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod; *

* BigDecimal 工具类 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class BigDecimals { 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 9ff3ca0..26ded88 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 @@ -41,7 +41,7 @@ import xyz.zhouxy.plusone.commons.time.YearQuarter; /** * 日期时间工具类 * - * @author ZhouXY108 + * @author ZhouXY */ public class DateTimeTools { @@ -387,7 +387,7 @@ public class DateTimeTools { * * @deprecated * 此方法使用系统默认时区，不建议使用。 - * 请使用 {@link #of(Date,ZoneId)}、{@link #of(Date,TimeZone)} 或其它工厂方法 + * 请使用 {@link #getQuarter(Date,ZoneId)}、{@link #getQuarter(Date,TimeZone)} 或其它工厂方法 */ @Deprecated public static YearQuarter getQuarter(Date date) { @@ -731,6 +731,7 @@ public class DateTimeTools { * 将指定日期范围转为日期时间范围 * * @param dateRange 日期范围 + * @param zone 时区 * @return 对应的日期时间范围 */ public static Range toDateTimeRange(Range dateRange, ZoneId zone) { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/EnumTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/EnumTools.java index da142b1..9db66d7 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/EnumTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/EnumTools.java @@ -26,7 +26,7 @@ import javax.annotation.Nullable; /** * 枚举工具类 * - * @author ZhouXY108 + * @author ZhouXY */ public final class EnumTools { @@ -173,9 +173,10 @@ public final class EnumTools { /** * 校验枚举的 ordinal，如果 ordinal 为 {@code null}，则返回 {@code defaultValue}。 * - * @param 枚举类型 - * @param enumType 枚举类型 - * @param ordinal The ordinal + * @param 枚举类型 + * @param enumType 枚举类型 + * @param ordinal The ordinal + * @param defaultValue 默认值 * @return The ordinal */ @Nullable 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 52d1cc8..bb891b5 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 @@ -36,8 +36,8 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod; *

* 参考 Enumeration classes * - * @author ZhouXY108 - * @deprecated 设计 Enumeration 的灵感来自于 .net 社区，因为 C# 的枚举不带行为。 + * @author ZhouXY + * @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 9bbf709..92fed02 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 @@ -30,7 +30,7 @@ import java.util.concurrent.ConcurrentHashMap; * * @see UUID * @see IdWorker - * @author ZhouXY108 + * @author ZhouXY */ public class IdGenerator { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/JodaTimeTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/JodaTimeTools.java index ad8d2c4..86d6d36 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/JodaTimeTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/JodaTimeTools.java @@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.util; /** * Joda-Time 工具类 * - * @author ZhouXY108 + * @author ZhouXY */ public class JodaTimeTools { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Numbers.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Numbers.java index 66a3214..d00745f 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Numbers.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Numbers.java @@ -25,7 +25,7 @@ import javax.annotation.Nullable; /** * 数字工具类 * - * @author ZhouXY108 + * @author ZhouXY */ public class Numbers { 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 6c031be..e47aeca 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 @@ -31,7 +31,7 @@ import com.google.common.annotations.Beta; *

* 提供一些 Optional 相关的方法 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 * @see Optional * @see OptionalInt 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 38f7626..0c34fab 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 @@ -30,7 +30,7 @@ import com.google.common.collect.Range; /** * 随机工具类 * - * @author ZhouXY108 + * @author ZhouXY */ public final class RandomTools { @@ -179,6 +179,7 @@ public final class RandomTools { /** * 使用传入的随机数生成器，生成随机整数 * + * @param random 随机数生成器。根据需要传入 * @param startInclusive 最小值（包含） * @param endExclusive 最大值（不包含） * @return 在区间 {@code [min, max)} 内的随机整数 @@ -222,6 +223,7 @@ public final class RandomTools { /** * 使用传入的随机数生成器，生成随机整数 * + * @param random 随机数生成器 * @param range 整数区间 * @return 在指定区间内的随机整数 * diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Ref.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Ref.java index 18e304b..63308c4 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Ref.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/Ref.java @@ -27,7 +27,7 @@ import javax.annotation.Nullable; /** * {@link Ref} 包装了一个值，表示对该值的应用。 * - *

灵感来自于 C# 的 {@code ref} 参数修饰符。C# 允许通过以下方式，将值返回给调用端：

+ *

灵感来自于 C# 的 {@code ref} 参数修饰符。C# 允许通过以下方式，将值返回给调用端：

* 
  * void Method(ref int refArgument)
  * {
@@ -67,7 +67,7 @@ import javax.annotation.Nullable;
  * System.out.println(result); // Output: Return string
  *
* - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public final class Ref { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RegexTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RegexTools.java index 6d12bff..9567157 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RegexTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/RegexTools.java @@ -35,7 +35,7 @@ import com.google.common.cache.LoadingCache; /** * 封装一些常用的正则操作，并可以缓存 {@link Pattern} 实例以复用。 * - * @author ZhouXY108 + * @author ZhouXY */ public final class RegexTools { 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 f06e5b2..c43570a 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 @@ -34,7 +34,7 @@ import xyz.zhouxy.plusone.commons.constant.PatternConsts; *

* 字符串工具类。 * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class StringTools { diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/TreeBuilder.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/TreeBuilder.java index cbe2398..7707d41 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/TreeBuilder.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/TreeBuilder.java @@ -32,7 +32,7 @@ import javax.annotation.Nullable; /** * TreeBuilder * - * @author ZhouXY108 + * @author ZhouXY * @since 1.0.0 */ public class TreeBuilder { @@ -76,6 +76,7 @@ public class TreeBuilder { * 注意避免 nodes 中的元素产生变化所带来的意料之外的影响。 * * @param nodes 平铺的节点列表 + * @return 构造结果 */ public List buildTree(Collection nodes) { checkNotNull(nodes); @@ -93,6 +94,7 @@ public class TreeBuilder { * 若为 {@code null}，则使用 {@link #defaultComparator}； * 若 {@link #defaultComparator} 也为 {@code null}，则不排序。 * 仅影响调用 addChild 的顺序，如果操作对象本身对应的控制了子节点的顺序，无法影响其相关逻辑。 + * @return 构建的树形结构 */ public List buildTree(Collection nodes, @Nullable Comparator comparator) { checkNotNull(nodes); diff --git a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ZipTools.java b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ZipTools.java index 5c0baa3..25cc183 100644 --- a/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ZipTools.java +++ b/plusone-commons/src/main/java/xyz/zhouxy/plusone/commons/util/ZipTools.java @@ -33,7 +33,7 @@ import javax.annotation.Nullable; *

* 提供最基础的数据压缩/解压方法 * - * @author ZhouXY108 + * @author ZhouXY * * @see Deflater * @see Inflater @@ -44,7 +44,6 @@ public class ZipTools { * 使用默认压缩级别压缩数据 * * @param input 输入 - * @param level 压缩级别 * @return 压缩后的数据 * * @throws IOException 发生 I/O 错误时抛出 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 dd1209c..919c8f3 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 @@ -20,7 +20,7 @@ * 包含树构建器（{@link TreeBuilder}）、断言工具（{@link AssertTools}）、 * ID 生成器（{@link IdGenerator}）及其它实用工具类。 * - * @author ZhouXY108 + * @author ZhouXY */ @ParametersAreNonnullByDefault package xyz.zhouxy.plusone.commons.util; diff --git a/plusone-commons/src/test/java/xyz/zhouxy/plusone/commons/model/dto/test/PagingAndSortingQueryParamsTests.java b/plusone-commons/src/test/java/xyz/zhouxy/plusone/commons/model/dto/test/PagingAndSortingQueryParamsTests.java index 9346972..95d5496 100644 --- a/plusone-commons/src/test/java/xyz/zhouxy/plusone/commons/model/dto/test/PagingAndSortingQueryParamsTests.java +++ b/plusone-commons/src/test/java/xyz/zhouxy/plusone/commons/model/dto/test/PagingAndSortingQueryParamsTests.java @@ -220,7 +220,7 @@ public class PagingAndSortingQueryParamsTests { /** * 账号信息查询参数 * - * @author ZhouXY108 + * @author ZhouXY */ @ToString(callSuper = true) class AccountQueryParams extends PagingAndSortingQueryParams {