forked from plusone/plusone-commons
docs: 更新作者信息并完善Javadoc文档
This commit is contained in:
@@ -27,7 +27,7 @@ import java.lang.annotation.Target;
|
||||
* <p>
|
||||
* 标识方法是读方法,如 getter。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see WriterMethod
|
||||
*/
|
||||
|
||||
@@ -26,7 +26,7 @@ import java.lang.annotation.Target;
|
||||
*
|
||||
* <p>标识方法为静态工厂方法
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Target(ElementType.METHOD)
|
||||
|
||||
@@ -27,7 +27,7 @@ import java.lang.annotation.Documented;
|
||||
*
|
||||
* <p>标识方法为不支持的操作。该方法将抛出 {@link UnsupportedOperationException}。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @version 1.0
|
||||
* @since 1.0.0
|
||||
* @see UnsupportedOperationException
|
||||
|
||||
@@ -25,7 +25,7 @@ import java.lang.annotation.Target;
|
||||
/**
|
||||
* ValueObject - 值对象
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Inherited
|
||||
|
||||
@@ -25,7 +25,7 @@ import java.lang.annotation.Target;
|
||||
* 标识该方法是虚方法。
|
||||
* <p>该注解用于提醒、强调父类虽然有默认实现,但子类可以根据自己的需要覆写。</p>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Target(ElementType.METHOD)
|
||||
|
||||
@@ -27,7 +27,7 @@ import java.lang.annotation.Target;
|
||||
* <p>
|
||||
* 标识方法是写方法,如 setter。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see ReaderMethod
|
||||
*/
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
/**
|
||||
* 注解
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
package xyz.zhouxy.plusone.commons.annotation;
|
||||
|
||||
@@ -26,7 +26,7 @@ import javax.annotation.Nullable;
|
||||
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
||||
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public interface IWithCode<T> {
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ import javax.annotation.Nullable;
|
||||
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
||||
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public interface IWithIntCode {
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ import javax.annotation.Nullable;
|
||||
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
||||
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public interface IWithLongCode {
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
/**
|
||||
* 基础内容
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@CheckReturnValue
|
||||
@ParametersAreNonnullByDefault
|
||||
|
||||
@@ -33,7 +33,7 @@ import com.google.common.collect.Table;
|
||||
/**
|
||||
* 集合工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class CollectionTools {
|
||||
|
||||
@@ -73,7 +73,7 @@ import com.google.common.annotations.Beta;
|
||||
* .getAndModify(HashMap::new);
|
||||
* </pre>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.1.0
|
||||
*/
|
||||
@Beta
|
||||
@@ -202,6 +202,7 @@ public class MapModifier<K, V> {
|
||||
* 修改 {@code map}
|
||||
*
|
||||
* @param map 要修改的 {@code map}
|
||||
* @param <T> {@code map} 的类型
|
||||
*/
|
||||
public <T extends Map<K, V>> void modify(@Nullable T map) {
|
||||
if (map == null || this.operations.isEmpty()) {
|
||||
@@ -214,6 +215,7 @@ public class MapModifier<K, V> {
|
||||
* 修改 {@code map}
|
||||
*
|
||||
* @param mapSupplier {@code map} 的 {@link Supplier}
|
||||
* @param <T> {@code map} 的类型
|
||||
* @return 修改后的 {@code map}。
|
||||
* 当从 {@code mapSupplier} 获取的 {@code map} 为 {@code null} 时,返回 {@code null}。
|
||||
*/
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
/**
|
||||
* 集合相关工具
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@ParametersAreNonnullByDefault
|
||||
package xyz.zhouxy.plusone.commons.collection;
|
||||
|
||||
@@ -21,7 +21,7 @@ import java.util.regex.Pattern;
|
||||
/**
|
||||
* 正则表达式常量
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @see RegexConsts
|
||||
* @see xyz.zhouxy.plusone.commons.util.RegexTools
|
||||
*/
|
||||
|
||||
@@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.constant;
|
||||
/**
|
||||
* 正则表达式常量
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @see PatternConsts
|
||||
*/
|
||||
public final class RegexConsts {
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
* </h3>
|
||||
* {@link RegexConsts} 包含常见正则表达式;{@link PatternConsts} 包含对应的 {@link Pattern} 对象。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
package xyz.zhouxy.plusone.commons.constant;
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.exception;
|
||||
/**
|
||||
* 数据不存在异常
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class DataNotExistsException extends Exception {
|
||||
|
||||
@@ -21,7 +21,7 @@ import javax.annotation.Nonnull;
|
||||
* 异常工厂
|
||||
*
|
||||
* @param <X> 异常类型
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public interface IExceptionFactory<X extends Exception> {
|
||||
/**
|
||||
|
||||
@@ -22,12 +22,14 @@ import xyz.zhouxy.plusone.commons.base.IWithCode;
|
||||
* 异常场景
|
||||
*
|
||||
* @param <TCode> 场景编码
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public interface IExceptionType<TCode> extends IWithCode<TCode> {
|
||||
|
||||
/**
|
||||
* 默认异常信息
|
||||
*
|
||||
* @return 默认异常信息
|
||||
*/
|
||||
String getDefaultMessage();
|
||||
|
||||
|
||||
@@ -118,7 +118,7 @@ import javax.annotation.Nonnull;
|
||||
* </pre>
|
||||
*
|
||||
* @param <T> 异常场景
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public interface IMultiTypesException<T extends IExceptionType<?>> {
|
||||
|
||||
@@ -33,7 +33,7 @@ import xyz.zhouxy.plusone.commons.exception.business.RequestParamsException;
|
||||
* throw new RequestParamsException(ParsingFailureException.Type.NUMBER_PARSING_FAILURE.create());
|
||||
* </pre>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class ParsingFailureException
|
||||
|
||||
@@ -25,7 +25,7 @@ package xyz.zhouxy.plusone.commons.exception.business;
|
||||
* <p>
|
||||
* <b>NOTE: 通常表示业务中的意外情况。如:用户错误输入、缺失必填字段、用户余额不足等。</b>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class BizException extends RuntimeException {
|
||||
|
||||
@@ -31,7 +31,7 @@ import xyz.zhouxy.plusone.commons.exception.IMultiTypesException;
|
||||
* <p>
|
||||
* <b>NOTE: 属业务异常</b>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class InvalidInputException
|
||||
|
||||
@@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.exception.business;
|
||||
* <p>
|
||||
* 用户请求参数错误
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class RequestParamsException extends BizException {
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
/**
|
||||
* 业务异常
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
package xyz.zhouxy.plusone.commons.exception.business;
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
/**
|
||||
* 包含常见的业务异常与系统异常,以及异常相关的工具
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
package xyz.zhouxy.plusone.commons.exception;
|
||||
|
||||
@@ -31,7 +31,7 @@ import javax.annotation.Nullable;
|
||||
* 当出现这种始料未及的诡异情况时,抛出 {@link JdbcUpdateAffectedIncorrectNumberOfRowsException} 并回滚事务。
|
||||
* 后续需要排查原因。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class JdbcUpdateAffectedIncorrectNumberOfRowsException extends SysException {
|
||||
|
||||
@@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.exception.system;
|
||||
* <p>
|
||||
* 在无法找到可访问的 Mac 地址时抛出
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class NoAvailableMacFoundException extends SysException {
|
||||
|
||||
@@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.exception.system;
|
||||
* <p>
|
||||
* 通常表示应用代码存在问题,或因环境问题,引发异常。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class SysException extends RuntimeException {
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
/**
|
||||
* 系统异常
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
package xyz.zhouxy.plusone.commons.exception.system;
|
||||
|
||||
@@ -25,7 +25,7 @@ import com.google.common.annotations.Beta;
|
||||
* 一个特殊的 {@link java.util.function.UnaryOperator}。
|
||||
* 表示对 {@code boolean} 值的一元操作。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see java.util.function.UnaryOperator
|
||||
*/
|
||||
|
||||
@@ -25,7 +25,7 @@ import com.google.common.annotations.Beta;
|
||||
* 一个特殊的 {@link java.util.function.UnaryOperator}。
|
||||
* 表示对 {@code char} 的一元操作。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see java.util.function.UnaryOperator
|
||||
*/
|
||||
|
||||
@@ -24,7 +24,7 @@ package xyz.zhouxy.plusone.commons.function;
|
||||
*
|
||||
* @param <E> 可抛出的异常类型
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
|
||||
@@ -25,7 +25,7 @@ import java.util.function.Supplier;
|
||||
* <p>
|
||||
* 返回 {@code Optional<T>} 对象。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see Optional
|
||||
* @see Supplier
|
||||
|
||||
@@ -24,7 +24,7 @@ import java.util.function.Predicate;
|
||||
* <p>
|
||||
* {@link Predicate} 相关操作。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see Predicate
|
||||
*/
|
||||
|
||||
@@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.function;
|
||||
* <p>
|
||||
* 允许抛出异常的消费操作。是一个特殊的 {@link java.util.function.Consumer}。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see java.util.function.Consumer
|
||||
*/
|
||||
@@ -33,6 +33,7 @@ public interface ThrowingConsumer<T, E extends Throwable> {
|
||||
* 消费给定的参数,允许抛出异常
|
||||
*
|
||||
* @param t 要消费的参数
|
||||
* @throws E 抛出的异常
|
||||
*/
|
||||
void accept(T t) throws E;
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ package xyz.zhouxy.plusone.commons.function;
|
||||
* @param <R> 返回结果类型
|
||||
* @param <E> 异常类型
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0
|
||||
* @see java.util.function.Function
|
||||
*/
|
||||
@@ -37,6 +37,7 @@ public interface ThrowingFunction<T, R, E extends Throwable> {
|
||||
*
|
||||
* @param t 入参
|
||||
* @return 函数结果
|
||||
* @throws E 抛出的异常
|
||||
*/
|
||||
R apply(T t) throws E;
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ package xyz.zhouxy.plusone.commons.function;
|
||||
* <p>
|
||||
* 接收一个参数,返回一个布尔值,可抛出异常。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see java.util.function.Predicate
|
||||
*/
|
||||
@@ -34,6 +34,7 @@ public interface ThrowingPredicate<T, E extends Throwable> {
|
||||
*
|
||||
* @param t 入参
|
||||
* @return 入参符合条件时返回 {@code true},否则返回 {@code false}
|
||||
* @throws E 抛出的异常
|
||||
*/
|
||||
boolean test(T t) throws E;
|
||||
}
|
||||
|
||||
@@ -25,7 +25,7 @@ package xyz.zhouxy.plusone.commons.function;
|
||||
* @param <T> 结果类型
|
||||
* @param <E> 异常类型
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see java.util.function.Supplier
|
||||
*/
|
||||
@@ -36,6 +36,7 @@ public interface ThrowingSupplier<T, E extends Throwable> {
|
||||
* 获取一个结果,允许抛出异常。
|
||||
*
|
||||
* @return 结果
|
||||
* @throws E 允许抛出的异常
|
||||
*/
|
||||
T get() throws E;
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ import java.util.function.BiFunction;
|
||||
* <p>
|
||||
* 接受类型为 T 和 U 的两个参数,返回 {@code Optional<R>} 对象。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see Optional
|
||||
* @see BiFunction
|
||||
|
||||
@@ -25,7 +25,7 @@ import java.util.function.Function;
|
||||
* <p>
|
||||
* 接受类型为 T 的参数,返回 {@code Optional<R>} 对象。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see Optional
|
||||
* @see Function
|
||||
|
||||
@@ -39,6 +39,6 @@
|
||||
* | Optional | ToOptionalFunction | Optional<R> apply(T) |
|
||||
* </pre>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
package xyz.zhouxy.plusone.commons.function;
|
||||
|
||||
@@ -33,7 +33,7 @@ import com.google.gson.stream.JsonWriter;
|
||||
/**
|
||||
* 包含 JSR-310 相关数据类型的 {@code TypeAdapter}
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.1.0
|
||||
* @see TypeAdapter
|
||||
* @see com.google.gson.GsonBuilder
|
||||
|
||||
@@ -42,7 +42,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
|
||||
* <p>
|
||||
* 中国第二代居民身份证号
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see xyz.zhouxy.plusone.commons.constant.PatternConsts#CHINESE_2ND_ID_CARD_NUMBER
|
||||
*/
|
||||
|
||||
@@ -23,7 +23,7 @@ import xyz.zhouxy.plusone.commons.base.IWithIntCode;
|
||||
/**
|
||||
* 性别
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public enum Gender implements IWithIntCode {
|
||||
UNKNOWN(0, "Unknown", "未知"),
|
||||
|
||||
@@ -24,7 +24,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
|
||||
/**
|
||||
* 身份证号
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public interface IDCardNumber {
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
|
||||
/**
|
||||
* SemVer 语义版本号
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.1.0
|
||||
*
|
||||
* @see <a href="https://semver.org/">Semantic Versioning 2.0.0</a>
|
||||
|
||||
@@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.annotation.ReaderMethod;
|
||||
/**
|
||||
* 带校验的字符串值对象
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @deprecated 弃用。使用工厂方法创建对象,并在其中进行校验即可。
|
||||
|
||||
@@ -29,7 +29,7 @@ import xyz.zhouxy.plusone.commons.collection.CollectionTools;
|
||||
*
|
||||
* @param <T> 内容列表的元素类型
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @see PagingAndSortingQueryParams
|
||||
*/
|
||||
public class PageResult<T> {
|
||||
|
||||
@@ -94,7 +94,7 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
|
||||
* }
|
||||
* </pre>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @see PagingParams
|
||||
* @see PageResult
|
||||
*/
|
||||
|
||||
@@ -24,7 +24,7 @@ import xyz.zhouxy.plusone.commons.model.dto.PagingAndSortingQueryParams.Sortable
|
||||
/**
|
||||
* 分页参数
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @see PagingAndSortingQueryParams
|
||||
*/
|
||||
public class PagingParams {
|
||||
|
||||
@@ -22,7 +22,7 @@ import javax.annotation.Nullable;
|
||||
/**
|
||||
* 统一结果,对返回给前端的数据进行封装。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public class UnifiedResponse<T> {
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ import javax.annotation.Nullable;
|
||||
* </pre>
|
||||
* 见 <a href="http://zhouxy.xyz:3000/plusone/plusone-commons/issues/22">issue#22</a>。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see UnifiedResponse
|
||||
*/
|
||||
@@ -70,6 +70,7 @@ public class UnifiedResponses {
|
||||
/**
|
||||
* 默认成功响应结果
|
||||
*
|
||||
* @param <T> 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 <T> data 类型
|
||||
* @return {@code UnifiedResponse} 对象。
|
||||
* {@code code} = "2000000", {@code data} = null
|
||||
*/
|
||||
@@ -114,6 +116,7 @@ public class UnifiedResponses {
|
||||
*
|
||||
* @param code 错误码
|
||||
* @param message 错误信息
|
||||
* @param <T> data 类型
|
||||
* @return {@code UnifiedResponse} 对象({@code data} 为 {@code null})
|
||||
*/
|
||||
public static <T> UnifiedResponse<T> error(String code, @Nullable String message) {
|
||||
@@ -159,6 +162,7 @@ public class UnifiedResponses {
|
||||
*
|
||||
* @param code 状态码
|
||||
* @param message 响应信息
|
||||
* @param <T> data 类型
|
||||
* @return {@code UnifiedResponse} 对象({@code data} 为 {@code null})
|
||||
*/
|
||||
public static <T> UnifiedResponse<T> of(String code, @Nullable String message) {
|
||||
|
||||
@@ -58,7 +58,7 @@
|
||||
* 用户可以继承 {@link UnifiedResponses} 实现自己的工厂类,
|
||||
* 自定义 SUCCESS_CODE 和 DEFAULT_SUCCESS_MSG,以及工厂方法。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@ParametersAreNonnullByDefault
|
||||
package xyz.zhouxy.plusone.commons.model.dto;
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
* <p>
|
||||
* 包含业务建模可能用到的性别、身份证等元素,也包含 DTO 相关类,如分页查询参数,响应结果,分页结果等。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@ParametersAreNonnullByDefault
|
||||
package xyz.zhouxy.plusone.commons.model;
|
||||
|
||||
@@ -32,7 +32,7 @@ import xyz.zhouxy.plusone.commons.base.IWithIntCode;
|
||||
/**
|
||||
* 季度
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public enum Quarter implements IWithIntCode {
|
||||
/** 第一季度 */
|
||||
|
||||
@@ -39,7 +39,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
|
||||
/**
|
||||
* 表示年份与季度
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@Immutable
|
||||
public final class YearQuarter implements Comparable<YearQuarter>, Serializable {
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
* 模仿 JDK 的 {@link java.time.Month} 和 {@link java.time.YearMonth},
|
||||
* 实现 {@link Quarter},{@link YearQuarter},对季度进行建模。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@ParametersAreNonnullByDefault
|
||||
package xyz.zhouxy.plusone.commons.time;
|
||||
|
||||
@@ -38,7 +38,7 @@ import javax.annotation.Nullable;
|
||||
* <p>
|
||||
* 数组工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class ArrayTools {
|
||||
@@ -1038,6 +1038,7 @@ public class ArrayTools {
|
||||
*
|
||||
* @param a 要填充的数组
|
||||
* @param values 填充内容
|
||||
* @param <T> 元素类型
|
||||
*/
|
||||
public static <T> 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 <T> 元素类型
|
||||
*/
|
||||
public static <T> void fill(T[] a, int fromIndex, int toIndex, @Nullable T[] values) {
|
||||
fillInternal(a, fromIndex, toIndex, values);
|
||||
|
||||
@@ -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");
|
||||
* </pre>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public class AssertTools {
|
||||
|
||||
@@ -112,6 +112,7 @@ public class AssertTools {
|
||||
*
|
||||
* @param <T> 入参类型
|
||||
* @param obj 入参
|
||||
* @return 校验通过时返回入参
|
||||
* @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出
|
||||
*/
|
||||
public static <T> T checkArgumentNotNull(@Nullable T obj) {
|
||||
@@ -127,6 +128,7 @@ public class AssertTools {
|
||||
* @param <T> 入参类型
|
||||
* @param obj 入参
|
||||
* @param errorMessage 异常信息
|
||||
* @return 校验通过时返回入参
|
||||
* @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出
|
||||
*/
|
||||
public static <T> T checkArgumentNotNull(@Nullable T obj, String errorMessage) {
|
||||
@@ -142,6 +144,7 @@ public class AssertTools {
|
||||
* @param <T> 入参类型
|
||||
* @param obj 入参
|
||||
* @param errorMessageSupplier 异常信息
|
||||
* @return 校验通过时返回入参
|
||||
* @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出
|
||||
*/
|
||||
public static <T> T checkArgumentNotNull(@Nullable T obj, Supplier<String> errorMessageSupplier) {
|
||||
@@ -158,6 +161,7 @@ public class AssertTools {
|
||||
* @param obj 入参
|
||||
* @param errorMessageTemplate 异常信息模板
|
||||
* @param errorMessageArgs 异常信息参数
|
||||
* @return 校验通过时返回入参
|
||||
* @throws IllegalArgumentException 当 {@code obj} 为 {@code null} 时抛出
|
||||
*/
|
||||
public static <T> T checkArgumentNotNull(@Nullable T obj,
|
||||
|
||||
@@ -31,7 +31,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
|
||||
* <p>
|
||||
* BigDecimal 工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class BigDecimals {
|
||||
|
||||
@@ -41,7 +41,7 @@ import xyz.zhouxy.plusone.commons.time.YearQuarter;
|
||||
/**
|
||||
* 日期时间工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @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<ZonedDateTime> toDateTimeRange(Range<LocalDate> dateRange, ZoneId zone) {
|
||||
|
||||
@@ -26,7 +26,7 @@ import javax.annotation.Nullable;
|
||||
/**
|
||||
* 枚举工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public final class EnumTools {
|
||||
|
||||
@@ -176,6 +176,7 @@ public final class EnumTools {
|
||||
* @param <E> 枚举类型
|
||||
* @param enumType 枚举类型
|
||||
* @param ordinal The ordinal
|
||||
* @param defaultValue 默认值
|
||||
* @return The ordinal
|
||||
*/
|
||||
@Nullable
|
||||
|
||||
@@ -36,8 +36,8 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
|
||||
* <p>
|
||||
* 参考 <a href="https://lostechies.com/jimmybogard/2008/08/12/enumeration-classes/">Enumeration classes</a>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @deprecated 设计 Enumeration 的灵感来自于 .net 社区,因为 C# 的枚举不带行为。
|
||||
* @author ZhouXY
|
||||
* @deprecated 设计 Enumeration 的灵感来自于 .net 社区,因为 C# 的枚举不带行为。
|
||||
* 但 Java 的枚举可以带行为,故大多数情况下不需要这种设计。
|
||||
*/
|
||||
@Deprecated
|
||||
|
||||
@@ -30,7 +30,7 @@ import java.util.concurrent.ConcurrentHashMap;
|
||||
*
|
||||
* @see UUID
|
||||
* @see IdWorker
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public class IdGenerator {
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.util;
|
||||
/**
|
||||
* Joda-Time 工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public class JodaTimeTools {
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ import javax.annotation.Nullable;
|
||||
/**
|
||||
* 数字工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public class Numbers {
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ import com.google.common.annotations.Beta;
|
||||
* <p>
|
||||
* 提供一些 Optional 相关的方法
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
* @see Optional
|
||||
* @see OptionalInt
|
||||
|
||||
@@ -30,7 +30,7 @@ import com.google.common.collect.Range;
|
||||
/**
|
||||
* 随机工具类
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @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 在指定区间内的随机整数
|
||||
*
|
||||
|
||||
@@ -27,7 +27,7 @@ import javax.annotation.Nullable;
|
||||
/**
|
||||
* {@link Ref} 包装了一个值,表示对该值的应用。
|
||||
*
|
||||
* <p>灵感来自于 C# 的 {@code ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:</p>
|
||||
* <p>灵感来自于 C# 的 {@code ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:</p>
|
||||
* <pre>
|
||||
* void Method(ref int refArgument)
|
||||
* {
|
||||
@@ -67,7 +67,7 @@ import javax.annotation.Nullable;
|
||||
* System.out.println(result); // Output: Return string
|
||||
* </pre>
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public final class Ref<T> {
|
||||
|
||||
@@ -35,7 +35,7 @@ import com.google.common.cache.LoadingCache;
|
||||
/**
|
||||
* 封装一些常用的正则操作,并可以缓存 {@link Pattern} 实例以复用。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
public final class RegexTools {
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ import xyz.zhouxy.plusone.commons.constant.PatternConsts;
|
||||
* <p>
|
||||
* 字符串工具类。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class StringTools {
|
||||
|
||||
@@ -32,7 +32,7 @@ import javax.annotation.Nullable;
|
||||
/**
|
||||
* TreeBuilder
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class TreeBuilder<T, TSubTree extends T, TIdentity> {
|
||||
@@ -76,6 +76,7 @@ public class TreeBuilder<T, TSubTree extends T, TIdentity> {
|
||||
* 注意避免 nodes 中的元素产生变化所带来的意料之外的影响。</b>
|
||||
*
|
||||
* @param nodes 平铺的节点列表
|
||||
* @return 构造结果
|
||||
*/
|
||||
public List<T> buildTree(Collection<T> nodes) {
|
||||
checkNotNull(nodes);
|
||||
@@ -93,6 +94,7 @@ public class TreeBuilder<T, TSubTree extends T, TIdentity> {
|
||||
* 若为 {@code null},则使用 {@link #defaultComparator};
|
||||
* 若 {@link #defaultComparator} 也为 {@code null},则不排序。
|
||||
* <b>仅影响调用 addChild 的顺序,如果操作对象本身对应的控制了子节点的顺序,无法影响其相关逻辑。</b>
|
||||
* @return 构建的树形结构
|
||||
*/
|
||||
public List<T> buildTree(Collection<T> nodes, @Nullable Comparator<? super T> comparator) {
|
||||
checkNotNull(nodes);
|
||||
|
||||
@@ -33,7 +33,7 @@ import javax.annotation.Nullable;
|
||||
* <p>
|
||||
* 提供最基础的数据压缩/解压方法
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*
|
||||
* @see Deflater
|
||||
* @see Inflater
|
||||
@@ -44,7 +44,6 @@ public class ZipTools {
|
||||
* 使用默认压缩级别压缩数据
|
||||
*
|
||||
* @param input 输入
|
||||
* @param level 压缩级别
|
||||
* @return 压缩后的数据
|
||||
*
|
||||
* @throws IOException 发生 I/O 错误时抛出
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
* 包含树构建器({@link TreeBuilder})、断言工具({@link AssertTools})、
|
||||
* ID 生成器({@link IdGenerator})及其它实用工具类。
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@ParametersAreNonnullByDefault
|
||||
package xyz.zhouxy.plusone.commons.util;
|
||||
|
||||
@@ -220,7 +220,7 @@ public class PagingAndSortingQueryParamsTests {
|
||||
/**
|
||||
* 账号信息查询参数
|
||||
*
|
||||
* @author ZhouXY108 <luquanlion@outlook.com>
|
||||
* @author ZhouXY
|
||||
*/
|
||||
@ToString(callSuper = true)
|
||||
class AccountQueryParams extends PagingAndSortingQueryParams {
|
||||
|
||||
Reference in New Issue
Block a user