7 Commits
1.0.0 ... 1.0.1

Author SHA1 Message Date
746603f939 1.0.1 2025-03-28 12:10:44 +08:00
73a99b630c doc: 修改 since 信息
1.0.0 之前新增的,其 since 修改为 1.0.0,统一以 1.0.0 作为初始版本

fix plusone/plusone-commons#30
2025-03-28 11:35:12 +08:00
f5b04a7ae8 docs: 改正 PredicateTools 的 javadoc (#39)
Reviewed-on: http://zhouxy.xyz:3000/plusone/plusone-commons/pulls/39
2025-03-28 10:39:56 +08:00
dde3d1d172 docs: 删除 IdWorker 的 author 信息
Reviewed-on: http://zhouxy.xyz:3000/plusone/plusone-commons/pulls/37
2025-03-28 09:31:02 +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
aadd1857de docs: 改正 OptionalTools 的 javadoc
Reviewed-on: http://zhouxy.xyz:3000/plusone/plusone-commons/pulls/35
2025-03-28 09:08:23 +08:00
e98fe66b65 docs: fix javadoc
fix issue plusone/plusone-commons#29
2025-03-28 08:55:35 +08:00
27 changed files with 31 additions and 32 deletions

View File

@@ -6,7 +6,7 @@
<groupId>xyz.zhouxy.plusone</groupId> <groupId>xyz.zhouxy.plusone</groupId>
<artifactId>plusone-commons</artifactId> <artifactId>plusone-commons</artifactId>
<version>1.0.0</version> <version>1.0.1</version>
<properties> <properties>
<!-- Basic properties --> <!-- Basic properties -->

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -28,7 +28,7 @@ import java.lang.annotation.Target;
* 标识方法是写方法,如 setter。 * 标识方法是写方法,如 setter。
* *
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a> * @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0 * @since 1.0.0
* @see ReaderMethod * @see ReaderMethod
*/ */
@Target(ElementType.METHOD) @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> * @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0 * @since 1.0.0
*/ */
public class CollectionTools { 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> * @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0 * @since 1.0.0
*/ */
public final class DataNotExistsException extends Exception { public final class DataNotExistsException extends Exception {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -19,14 +19,14 @@ package xyz.zhouxy.plusone.commons.function;
import java.util.function.Predicate; import java.util.function.Predicate;
/** /**
* Predicates * PredicateTools
* *
* <p> * <p>
* {@link Predicate} 相关操作。 * {@link Predicate} 相关操作。
* </p> * </p>
* *
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a> * @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 0.1.0 * @since 1.0.0
* @see Predicate * @see Predicate
*/ */
public class PredicateTools { public class PredicateTools {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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