Compare commits

...

5 Commits

Author SHA1 Message Date
25628c8427 docs: 介绍 UnifiedResponses 的文档中 CustomUnifiedResponseFactoryTests 链接到代码托管平台对应的页面 2025-03-28 11:47:36 +08:00
5cca5771c2 doc: 修改 since 信息 (#40)
1.0.0 之前新增的,其 since 修改为 1.0.0,统一以 1.0.0 作为初始版本

Reviewed-on: plusone/plusone-commons#40

fix plusone/plusone-commons#30
2025-03-28 11:29:37 +08:00
03399355ed docs: 改正 PredicateTools 的 javadoc (#38)
Reviewed-on: plusone/plusone-commons#38
2025-03-28 10:35:47 +08:00
9fbba72175 docs: 删除 IdWorker 的 author 信息
Reviewed-on: plusone/plusone-commons#36
2025-03-28 09:29:08 +08:00
e3d60ffe97 docs: 删除 IdWorker 的 author 信息
该工具来自 seata,并非本项目原创,写 javadoc 时忘记修改模板中的 author,而seata 源代码中早就删除了该类的 author 信息,故应先删除。

见:https://github.com/apache/incubator-seata/pull/6179

close plusone/plusone-commons#31
2025-03-28 09:22:55 +08:00
27 changed files with 32 additions and 32 deletions

View File

@ -28,7 +28,7 @@ import java.lang.annotation.Target;
* 标识方法是读方法 getter
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0
* @since 1.0.0
* @see WriterMethod
*/
@Target(ElementType.METHOD)

View File

@ -27,7 +27,7 @@ import java.lang.annotation.Target;
* <p>标识方法为静态工厂方法
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)

View File

@ -29,7 +29,7 @@ import java.lang.annotation.Documented;
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @version 1.0
* @since 1.0
* @since 1.0.0
* @see UnsupportedOperationException
*/
@Documented

View File

@ -26,7 +26,7 @@ import java.lang.annotation.Target;
* ValueObject - 值对象
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
@Inherited
@Target(ElementType.TYPE)

View File

@ -26,7 +26,7 @@ import java.lang.annotation.Target;
* <p>该注解用于提醒强调父类虽然有默认实现但子类可以根据自己的需要覆写</p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)

View File

@ -28,7 +28,7 @@ import java.lang.annotation.Target;
* 标识方法是写方法 setter
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0
* @since 1.0.0
* @see ReaderMethod
*/
@Target(ElementType.METHOD)

View File

@ -34,7 +34,7 @@ import com.google.common.collect.Table;
* 集合工具类
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class CollectionTools {

View File

@ -20,7 +20,7 @@ package xyz.zhouxy.plusone.commons.exception;
* 数据不存在异常
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public final class DataNotExistsException extends Exception {

View File

@ -36,7 +36,7 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException.ExceptionType;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public final class ParsingFailureException
extends RuntimeException

View File

@ -27,7 +27,7 @@ package xyz.zhouxy.plusone.commons.exception.business;
* <b>NOTE: 通常表示业务中的意外情况用户错误输入缺失必填字段用户余额不足等</b>
* </p>
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class BizException extends RuntimeException {

View File

@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException;
* <b>NOTE: 属业务异常</b>
* </p>
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public final class InvalidInputException
extends RequestParamsException

View File

@ -24,7 +24,7 @@ package xyz.zhouxy.plusone.commons.exception.business;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class RequestParamsException extends BizException {

View File

@ -29,7 +29,7 @@ package xyz.zhouxy.plusone.commons.exception.system;
* 后续需要排查原因
* </p>
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public final class DataOperationResultException extends SysException {

View File

@ -24,7 +24,7 @@ package xyz.zhouxy.plusone.commons.exception.system;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class NoAvailableMacFoundException extends SysException {
private static final long serialVersionUID = 152827098461071551L;

View File

@ -24,7 +24,7 @@ package xyz.zhouxy.plusone.commons.exception.system;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class SysException extends RuntimeException {

View File

@ -24,9 +24,9 @@ import java.util.function.Supplier;
*
* <p>
* 返回 {@code Optional&lt;T&gt;} 对象
*
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
* @see Optional
* @see Supplier
*/

View File

@ -19,14 +19,14 @@ package xyz.zhouxy.plusone.commons.function;
import java.util.function.Predicate;
/**
* Predicates
* PredicateTools
*
* <p>
* {@link Predicate} 相关操作
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
* @see Predicate
*/
public class PredicateTools {
@ -36,12 +36,12 @@ public class PredicateTools {
* 如将 {@code Objects::nonNull} 明确地指定为 {@code Predicate&lt;String&gt;}
* 使之可以链式调用 {@link Predicate#and(Predicate)}{@link Predicate#or(Predicate)}
* 等方法连接其它 {@code Predicate<? super T>} 对象
*
*
* <pre>
* Predicate&lt;String&gt; predicate = PredicateTools.&lt;String&gt;from(Objects::nonNull)
* .and(StringUtils::isNotEmpty);
* </pre>
*
*
* @param <T> 目标类型
* @param predicate Lambda 表达式
* @return 传入的表达式自动成为 {@link Predicate} 实例

View File

@ -26,7 +26,7 @@ import java.util.function.BiFunction;
* 接受类型为 T U 的两个参数返回 {@code Optional&lt;R&gt;} 对象
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
* @see Optional
* @see BiFunction
*/

View File

@ -26,7 +26,7 @@ import java.util.function.Function;
* 接受类型为 T 的参数返回 {@code Optional&lt;R&gt;} 对象
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
* @see Optional
* @see Function
*/

View File

@ -39,7 +39,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0
* @since 1.0.0
* @see xyz.zhouxy.plusone.commons.constant.PatternConsts#CHINESE_2ND_ID_CARD_NUMBER
*/
@ValueObject

View File

@ -30,7 +30,7 @@ import xyz.zhouxy.plusone.commons.util.AssertTools;
* 带校验的字符串值对象
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public abstract class ValidatableStringRecord<T extends ValidatableStringRecord<T>>
implements Comparable<T> {

View File

@ -55,8 +55,9 @@
* <p>
* 可使用 {@link UnifiedResponses} 快速构建 {@link UnifiedResponse} 对象
* {@link UnifiedResponses} 默认的成功代码为 "2000000"
* 用户按测试类 CustomUnifiedResponseFactoryTests 中所示范的继承 {@link UnifiedResponses}
* 实现自己的工厂类
* 用户按测试类
* <a href="http://zhouxy.xyz:3000/plusone/plusone-commons/src/branch/main/src/test/java/xyz/zhouxy/plusone/commons/model/dto/CustomUnifiedResponseFactoryTests.java">CustomUnifiedResponseFactoryTests</a>
* 中所示范的继承 {@link UnifiedResponses} 实现自己的工厂类
* 自定义 SUCCESS_CODE DEFAULT_SUCCESS_MSG 和工厂方法
* <a href="http://zhouxy.xyz:3000/plusone/plusone-commons/issues/22">issue#22</a>
* </p>

View File

@ -36,7 +36,7 @@ import javax.annotation.Nullable;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class ArrayTools {

View File

@ -31,7 +31,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
*/
public class BigDecimals {

View File

@ -44,7 +44,6 @@ import xyz.zhouxy.plusone.commons.exception.system.NoAvailableMacFoundException;
* <li><a href="https://juejin.cn/post/7265516484029743138">关于若干读者阅读改良版雪花算法后提出的几个共性问题的回复</a></li>
* </ul>
* </p>
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/
public class IdWorker {

View File

@ -32,7 +32,7 @@ import com.google.common.annotations.Beta;
* 提供一些 Optional 相关的方法
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0
* @since 1.0.0
* @see Optional
* @see OptionalInt
* @see OptionalLong

View File

@ -31,7 +31,7 @@ import javax.annotation.Nullable;
* TreeBuilder
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0
* @since 1.0.0
*/
public class TreeBuilder<T, TSubTree extends T, TIdentity> {
private final Function<T, TIdentity> identityGetter;