From 654ecd8c6362993c3126c72a2972c6f48432d154 Mon Sep 17 00:00:00 2001 From: ZhouXY108 Date: Sun, 8 Jun 2025 04:34:08 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../validator/ArrayPropertyValidator.java | 86 ++++++----- .../BaseComparablePropertyValidator.java | 45 +++--- .../validator/BasePropertyValidator.java | 91 ++++++----- .../plusone/validator/BaseValidator.java | 125 ++++++++------- .../validator/BoolPropertyValidator.java | 44 +++--- .../CollectionPropertyValidator.java | 93 +++++------ .../ComparablePropertyValidator.java | 10 +- .../validator/DoublePropertyValidator.java | 53 +++---- .../zhouxy/plusone/validator/IValidator.java | 9 +- .../validator/IntPropertyValidator.java | 87 +++++------ .../validator/LongPropertyValidator.java | 56 +++---- .../validator/ObjectPropertyValidator.java | 2 + .../validator/PairPropertyValidator.java | 7 +- .../validator/StringPropertyValidator.java | 144 +++++++++--------- .../validator/ValidationException.java | 34 ++--- 15 files changed, 472 insertions(+), 414 deletions(-) diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ArrayPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ArrayPropertyValidator.java index 28c612d..25d7090 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ArrayPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ArrayPropertyValidator.java @@ -24,11 +24,13 @@ import xyz.zhouxy.plusone.commons.util.ArrayTools; import xyz.zhouxy.plusone.commons.util.AssertTools; /** - * 针对数组类型的属性校验器 + * 数组类型属性的校验器 * *

- * 内置数组相关的校验规则。 + * 用于构建校验数组类型属性的规则链。 * + * @param 待校验对象的类型 + * @param 数组元素的类型 * @author ZhouXY */ public class ArrayPropertyValidator @@ -45,7 +47,7 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性是否非空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator notEmpty() { return withRule(Conditions.notEmpty(), "The input must not be empty."); @@ -55,7 +57,7 @@ public class ArrayPropertyValidator * 添加一条校验属性的规则，校验属性是否非空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator notEmpty( final String errorMessage) { @@ -67,7 +69,7 @@ public class ArrayPropertyValidator * * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator notEmpty( final Supplier exceptionSupplier) { @@ -79,7 +81,7 @@ public class ArrayPropertyValidator * * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator notEmpty( final Function exceptionFunction) { @@ -97,7 +99,7 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性是否为空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator isEmpty() { return withRule(Conditions.isEmpty(), "The input must be empty."); @@ -107,7 +109,7 @@ public class ArrayPropertyValidator * 添加一条校验属性的规则，校验属性是否为空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator isEmpty( final String errorMessage) { @@ -117,8 +119,9 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性是否为空 * + * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator isEmpty( final Supplier exceptionSupplier) { @@ -128,8 +131,9 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性是否为空 * + * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator isEmpty( final Function exceptionFunction) { @@ -145,10 +149,10 @@ public class ArrayPropertyValidator // ================================ /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * - * @param condition 校验规则 - * @return 属性校验器 + * @param condition 校验条件 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator allMatch(final Predicate condition) { return withRule(c -> { @@ -161,11 +165,11 @@ public class ArrayPropertyValidator } /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * - * @param condition 校验规则 + * @param condition 校验条件 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator allMatch( final Predicate condition, final String errorMessage) { @@ -179,11 +183,12 @@ public class ArrayPropertyValidator } /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * - * @param condition 校验规则 + * @param 自定义异常类型 + * @param condition 校验条件 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator allMatch( final Predicate condition, final Supplier exceptionSupplier) { @@ -197,11 +202,12 @@ public class ArrayPropertyValidator } /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * - * @param condition 校验规则 + * @param 自定义异常类型 + * @param condition 校验条件 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator allMatch( final Predicate condition, final Function exceptionFunction) { @@ -225,9 +231,9 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性长度是否等于指定长度 * - * @param length 指定长度 + * @param length 预期长度 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator length( final int length, final String errorMessage) { @@ -237,10 +243,10 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性长度是否等于指定长度 * - * @param 异常类型 - * @param length 指定长度 + * @param 自定义异常类型 + * @param length 预期长度 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator length( final int length, final Supplier exceptionSupplier) { @@ -250,10 +256,10 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性长度是否等于指定长度 * - * @param 异常类型 - * @param length 指定长度 + * @param 自定义异常类型 + * @param length 预期长度 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator length( final int length, final Function exceptionFunction) { @@ -263,10 +269,10 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性的长度范围 * - * @param min 最小长度 - * @param max 最大长度 + * @param min 最小长度（包含） + * @param max 最大长度（包含） * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator length( final int min, final int max, final String errorMessage) { @@ -276,10 +282,11 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性的长度范围 * - * @param min 最小长度 - * @param max 最大长度 + * @param 自定义异常类型 + * @param min 最小长度（包含） + * @param max 最大长度（包含） * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator length( final int min, final int max, final Supplier exceptionSupplier) { @@ -289,10 +296,11 @@ public class ArrayPropertyValidator /** * 添加一条校验属性的规则，校验属性的长度范围 * - * @param min 最小长度 - * @param max 最大长度 + * @param 自定义异常类型 + * @param min 最小长度（包含） + * @param max 最大长度（包含） * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final ArrayPropertyValidator length( final int min, final int max, final Function exceptionFunction) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseComparablePropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseComparablePropertyValidator.java index 7e0b5eb..c88965e 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseComparablePropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseComparablePropertyValidator.java @@ -23,14 +23,11 @@ import java.util.function.Supplier; import com.google.common.collect.Range; /** - * 针对 {@code Comparable} 类型的属性校验器基类 + * {@code Comparable} 类型属性的校验器的基类 * - *

- * 内置了判断属性是否在给定区间内的校验规则。 - * - * @param 待校验对象类型 - * @param 属性类型 - * @param 当前属性校验器类型，用于链式调用 + * @param 待校验对象的类型 + * @param 待校验属性的类型，必须实现 {@code Comparable} 接口 + * @param 具体校验器类型，用于支持链式调用 * @see Range * @author ZhouXY */ @@ -45,53 +42,59 @@ public abstract class BaseComparablePropertyValidator< } /** - * 添加一条校验属性的规则，校验属性是否在给定的区间之内 + * 添加一条校验属性的规则，校验属性的取值范围。 * * @param range 区间 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator inRange(final Range range) { return withRule(Conditions.inRange(range), value -> ValidationException.withMessage( - "The input must in the interval %s. You entered %s.", range, value)); + "The input must in the interval %s. You entered %s.", range, value)); } /** - * 添加一条校验属性的规则，校验属性是否在给定的区间之内 + * 添加一条校验属性的规则，校验属性的取值范围。 * * @param range 区间 - * @param errorMessage 异常信息 - * @return 属性校验器 + * @param errorMessage 自定义错误消息模板 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator inRange( - final Range range, final String errorMessage) { + final Range range, final String errorMessage) { return withRule(Conditions.inRange(range), errorMessage); } /** - * 添加一条校验属性的规则，校验属性是否在给定的区间之内 + * 添加一条校验属性的规则，校验属性的取值范围。 * + * @param 自定义异常类型 * @param range 区间 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator inRange( - final Range range, final Supplier exceptionSupplier) { + final Range range, final Supplier exceptionSupplier) { return withRule(Conditions.inRange(range), exceptionSupplier); } /** - * 添加一条校验属性的规则，校验属性是否在给定的区间之内 + * 添加一条校验属性的规则，校验属性的取值范围。 * + * @param 自定义异常类型 * @param range 区间 - * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @param exceptionFunction 根据属性值生成异常的函数 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator inRange( - final Range range, final Function exceptionFunction) { + final Range range, final Function exceptionFunction) { return withRule(Conditions.inRange(range), exceptionFunction); } + /** + * 校验条件的实现 + */ private static class Conditions { + private static > Predicate inRange( final Range range) { return value -> value == null || range.contains(value); diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BasePropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BasePropertyValidator.java index d739577..64b7a8a 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BasePropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BasePropertyValidator.java @@ -28,9 +28,11 @@ import java.util.function.Supplier; * 属性校验器。包含针对属性的校验规则。 * *

- * 内置基础的校验规则。 - *

+ * 用于构建针对特定属性的校验规则链，支持通过链式调用添加多种校验规则。 * + * @param 待校验对象的类型 + * @param 待校验属性的类型 + * @param 具体校验器类型，用于支持链式调用 * @author ZhouXY */ public abstract class BasePropertyValidator< @@ -47,11 +49,12 @@ public abstract class BasePropertyValidator< } /** - * 添加一条校验属性的规则 + * 添加一条校验属性的规则，当条件不满足时抛出异常。 * * @param condition 校验条件 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 + * @throws ValidationException 校验失败时抛出的异常 */ protected final TPropertyValidator withRule( final Predicate condition, @@ -67,9 +70,10 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则 * * @param condition 校验条件 - * @param errorMessageTemplate 错误信息模版 - * @param errorMessageArgs 错误信息参数 - * @return 属性校验器 + * @param errorMessageTemplate 异常信息模板 + * @param errorMessageArgs 异常信息参数 + * @return 当前校验器实例，用于链式调用 + * @throws ValidationException 校验失败时抛出的异常 */ protected final TPropertyValidator withRule( final Predicate condition, @@ -84,9 +88,10 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则 * + * @param 自定义异常类型 * @param condition 校验条件 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ protected final TPropertyValidator withRule( final Predicate condition, @@ -99,11 +104,12 @@ public abstract class BasePropertyValidator< } /** - * 添加一条校验属性的规则 + * 添加一条校验属性的规则，当条件不满足时抛出自定义异常。可以根据当前属性的值创建异常。 * + * @param 自定义异常类型 * @param condition 校验条件 - * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @param exceptionFunction 自定义异常（以当前属性值为参数） + * @return 当前校验器实例，用于链式调用 */ protected final TPropertyValidator withRule( final Predicate condition, @@ -118,8 +124,8 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则 * - * @param rule 校验规则 - * @return 属性校验器 + * @param rule 自定义校验规则 + * @return 当前校验器实例，用于链式调用 */ protected final TPropertyValidator withRule(Consumer rule) { this.consumers.add(rule); @@ -150,7 +156,7 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则，校验属性是否不为空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notNull() { return withRule(Objects::nonNull, "The input must not be null."); @@ -160,7 +166,7 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否不为空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notNull(final String errorMessage) { return withRule(Objects::nonNull, errorMessage); @@ -171,7 +177,7 @@ public abstract class BasePropertyValidator< * * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notNull( final Supplier exceptionSupplier) { @@ -183,7 +189,7 @@ public abstract class BasePropertyValidator< * * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notNull( final Function exceptionFunction) { @@ -201,7 +207,7 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则，校验属性是否为空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator isNull() { return withRule(Objects::isNull, "The input must be null."); @@ -211,7 +217,7 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否为空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator isNull(final String errorMessage) { return withRule(Objects::isNull, errorMessage); @@ -222,7 +228,7 @@ public abstract class BasePropertyValidator< * * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator isNull( final Supplier exceptionSupplier) { @@ -234,7 +240,7 @@ public abstract class BasePropertyValidator< * * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator isNull( final Function exceptionFunction) { @@ -252,8 +258,8 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则，校验属性是否等于给定值 * - * @param that 给定值 - * @return 属性校验器 + * @param that 用于比较的对象 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator equal(Object that) { return withRule(Conditions.equal(that), @@ -263,9 +269,9 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则，校验属性是否等于给定值 * - * @param that 给定值 + * @param that 用于比较的对象 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator equal( final Object that, final String errorMessage) { @@ -276,9 +282,9 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否等于给定值 * * @param 自定义异常类型 - * @param that 给定值 + * @param that 用于比较的对象 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator equal( final Object that, final Supplier exceptionSupplier) { @@ -289,9 +295,9 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否等于给定值 * * @param 自定义异常类型 - * @param that 给定值 + * @param that 用于比较的对象 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator equal( final Object that, final Function exceptionFunction) { @@ -309,8 +315,8 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则，校验属性是否等于给定值 * - * @param that 给定值 - * @return 属性校验器 + * @param that 用于比较的对象 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notEqual(final Object that) { return withRule(Conditions.notEqual(that), @@ -320,9 +326,9 @@ public abstract class BasePropertyValidator< /** * 添加一条校验属性的规则，校验属性是否等于给定值 * - * @param that 给定值 + * @param that 用于比较的对象 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notEqual(final Object that, final String errorMessage) { return withRule(Conditions.notEqual(that), errorMessage); @@ -332,9 +338,9 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否等于给定值 * * @param 自定义异常类型 - * @param that 给定值 + * @param that 用于比较的对象 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notEqual( final Object that, final Supplier exceptionSupplier) { @@ -345,9 +351,9 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否等于给定值 * * @param 自定义异常类型 - * @param that 给定值 + * @param that 用于比较的对象 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator notEqual( final Object that, final Function exceptionFunction) { @@ -366,7 +372,7 @@ public abstract class BasePropertyValidator< * 添加一条校验属性的规则，校验属性是否满足给定的条件 * * @param condition 校验条件 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator must(final Predicate condition) { return withRule(condition, @@ -378,7 +384,7 @@ public abstract class BasePropertyValidator< * * @param condition 校验条件 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator must( final Predicate condition, @@ -392,7 +398,7 @@ public abstract class BasePropertyValidator< * @param 自定义异常类型 * @param condition 校验规则 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator must( final Predicate condition, @@ -406,7 +412,7 @@ public abstract class BasePropertyValidator< * @param 自定义异常类型 * @param condition 校验规则 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final TPropertyValidator must( final Predicate condition, @@ -422,6 +428,9 @@ public abstract class BasePropertyValidator< // #region - conditions // ================================ + /** + * 常用校验条件的实现 + */ private static class Conditions { private static Predicate equal(Object obj) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseValidator.java index 2a02a30..0638d20 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BaseValidator.java @@ -28,22 +28,19 @@ import java.util.function.Supplier; import xyz.zhouxy.plusone.validator.function.*; /** - * 校验器的基类 - * + * 校验器基类 *

- * 通过继承 {@code BaseValidator}，可以自定义一个针对特定类型的校验器，包含对该类型的校验逻辑。 + * 子类可通过添加不同的校验规则，构建完整的校验逻辑，用于校验对象。 * + * @param 待校验对象的类型 * @author ZhouXY */ public abstract class BaseValidator implements IValidator { - /** - * 规则集合 - */ private final List> rules = new ArrayList<>(); /** - * 添加一个校验规则 + * 添加一条用于校验整个对象的规则 * * @param condition 校验条件 * @param errorMessage 异常信息 @@ -53,7 +50,7 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个校验规则 + * 添加一条用于校验整个对象的规则 * * @param 自定义异常类型 * @param condition 校验条件 @@ -65,7 +62,7 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个校验规则 + * 添加一条用于校验整个对象的规则 * * @param 自定义异常类型 * @param condition 校验条件 @@ -81,19 +78,21 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个校验规则 + * 添加一条用于校验整个对象的规则 * - * @param rule 校验规则。内部包含断言条件，如果条件不满足，则抛出异常。 + * @param rule 自定义校验规则 */ protected final void withRule(Consumer rule) { this.rules.add(rule); } /** - * 添加一个属性校验器 + * 添加一个通用的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param 属性类型 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code ObjectPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final ObjectPropertyValidator ruleFor(Function getter) { ObjectPropertyValidator validator = new ObjectPropertyValidator<>(getter); @@ -102,11 +101,12 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Comparable} 属性的校验器 + * 添加一个用于校验 {@code Comparable} 类型的属性校验器 * * @param 属性类型 - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code ComparablePropertyValidator}。用于添加针对该属性的校验规则。 */ protected final > ComparablePropertyValidator ruleForComparable( Function getter) { @@ -116,10 +116,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Integer} 属性的校验器 + * 添加一个用于校验 {@code Integer} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code IntPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final IntPropertyValidator ruleForInt(Function getter) { IntPropertyValidator validator = new IntPropertyValidator<>(getter); @@ -128,10 +129,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Integer} 属性的校验器 + * 添加一个用于校验 {@code Integer} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code IntPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final IntPropertyValidator ruleFor(ToIntegerFunction getter) { IntPropertyValidator validator = new IntPropertyValidator<>(getter); @@ -140,10 +142,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Long} 属性的校验器 + * 添加一个用于校验 {@code Long} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code LongPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final LongPropertyValidator ruleForLong(Function getter) { LongPropertyValidator validator = new LongPropertyValidator<>(getter); @@ -152,10 +155,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Long} 属性的校验器 + * 添加一个用于校验 {@code Long} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code LongPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final LongPropertyValidator ruleFor(ToLongObjectFunction getter) { LongPropertyValidator validator = new LongPropertyValidator<>(getter); @@ -164,10 +168,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Double} 属性的校验器 + * 添加一个用于校验 {@code Double} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code DoublePropertyValidator}。用于添加针对该属性的校验规则。 */ protected final DoublePropertyValidator ruleForDouble(Function getter) { DoublePropertyValidator validator = new DoublePropertyValidator<>(getter); @@ -176,10 +181,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Double} 属性的校验器 + * 添加一个用于校验 {@code Double} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code DoublePropertyValidator}。用于添加针对该属性的校验规则。 */ protected final DoublePropertyValidator ruleFor(ToDoubleObjectFunction getter) { DoublePropertyValidator validator = new DoublePropertyValidator<>(getter); @@ -188,10 +194,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Boolean} 属性的校验器 + * 添加一个用于校验 {@code Boolean} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code BoolPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final BoolPropertyValidator ruleForBool(Function getter) { BoolPropertyValidator validator = new BoolPropertyValidator<>(getter); @@ -200,10 +207,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Boolean} 属性的校验器 + * 添加一个用于校验 {@code Boolean} 类型的属性校验器 * - * @param getter 属性获取函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code BoolPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final BoolPropertyValidator ruleFor(ToBoolObjectFunction getter) { BoolPropertyValidator validator = new BoolPropertyValidator<>(getter); @@ -212,10 +220,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code String} 属性的校验器 + * 添加一个用于校验 {@code String} 类型的属性校验器 * - * @param getter 获取属性值的函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code StringPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final StringPropertyValidator ruleForString(Function getter) { StringPropertyValidator validator = new StringPropertyValidator<>(getter); @@ -224,10 +233,11 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code String} 属性的校验器 + * 添加一个用于校验 {@code String} 类型的属性校验器 * - * @param getter 获取属性值的函数 - * @return 属性校验器 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code StringPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final StringPropertyValidator ruleFor(ToStringFunction getter) { StringPropertyValidator validator = new StringPropertyValidator<>(getter); @@ -236,10 +246,12 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对 {@code Collection} 属性的校验器 + * 添加一个用于校验集合类型的属性校验器 * - * @param getter 获取属性值的函数 - * @return 集合属性校验器 + * @param 集合元素类型 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code CollectionPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final CollectionPropertyValidator ruleForCollection(Function> getter) { CollectionPropertyValidator validator = new CollectionPropertyValidator<>(getter); @@ -248,10 +260,12 @@ public abstract class BaseValidator implements IValidator { } /** - * 添加一个针对数组属性的校验器 + * 添加一个用于校验数组类型的属性校验器 * - * @param getter 获取属性值的函数 - * @return 集合属性校验器 + * @param 数组元素类型 + * @param getter 用于从目标对象获取属性值的函数式接口。 + * 示例：{@code Person::getName}。 + * @return {@code ArrayPropertyValidator}。用于添加针对该属性的校验规则。 */ protected final ArrayPropertyValidator ruleForArray(Function getter) { ArrayPropertyValidator validator = new ArrayPropertyValidator<>(getter); @@ -261,10 +275,11 @@ public abstract class BaseValidator implements IValidator { /** * 添加一个针对二元组的校验器 + * * @param 第一个元素的类型 * @param 第二个元素的类型 - * @param getter 获取属性值的函数 - * @return 二元组校验器 + * @param getter 根据对象构造一个二元组，通常是两个属性的值。 + * @return {@code PairPropertyValidator}。用于添加针对该二元组的校验规则。 */ protected final PairPropertyValidator ruleForPair(Function> getter) { PairPropertyValidator validator = new PairPropertyValidator<>(getter); diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BoolPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BoolPropertyValidator.java index b66b3f4..e545501 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BoolPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/BoolPropertyValidator.java @@ -21,12 +21,12 @@ import java.util.function.Predicate; import java.util.function.Supplier; /** - * 针对 {@code Boolean} 类型的属性校验器 + * {@code Boolean} 类型属性的校验器 * *

- * 内置了判断 Boolean 值是否为 true 或 false 的校验规则。 - *

+ * 用于构建校验 {@code Boolean} 类型属性的规则链。 * + * @param 待校验对象的类型 * @author ZhouXY */ public class BoolPropertyValidator @@ -39,30 +39,30 @@ public class BoolPropertyValidator // ====== isTrueValue ====== /** - * 添加一条判断属性值是否为 {@code true} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code true} * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isTrueValue() { return withRule(Conditions.isTrueValue(), "The input must be true."); } /** - * 添加一条判断属性值是否为 {@code true} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code true} * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isTrueValue(final String errorMessage) { return withRule(Conditions.isTrueValue(), errorMessage); } /** - * 添加一条判断属性值是否为 {@code true} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code true} * * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isTrueValue( final Supplier exceptionSupplier) { @@ -70,44 +70,44 @@ public class BoolPropertyValidator } /** - * 添加一条判断属性值是否为 {@code true} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code true} * * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isTrueValue( - Function exceptionFunction) { + final Function exceptionFunction) { return withRule(Conditions.isTrueValue(), exceptionFunction); } // ====== isFalseValue ====== /** - * 添加一条判断属性值是否为 {@code false} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code false} * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isFalseValue() { return withRule(Conditions.isFalseValue(), "The input must be false."); } /** - * 添加一条判断属性值是否为 {@code false} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code false} * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isFalseValue(final String errorMessage) { return withRule(Conditions.isFalseValue(), errorMessage); } /** - * 添加一条判断属性值是否为 {@code false} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code false} * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isFalseValue( final Supplier exceptionSupplier) { @@ -115,11 +115,11 @@ public class BoolPropertyValidator } /** - * 添加一条判断属性值是否为 {@code false} 的校验规则 + * 添加一条校验属性的规则，校验属性是否为 {@code false} * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final BoolPropertyValidator isFalseValue( final Function exceptionFunction) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/CollectionPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/CollectionPropertyValidator.java index 7b90f7e..e4e80eb 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/CollectionPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/CollectionPropertyValidator.java @@ -25,11 +25,13 @@ import xyz.zhouxy.plusone.commons.collection.CollectionTools; import xyz.zhouxy.plusone.commons.util.AssertTools; /** - * 针对集合类型的属性校验器 + * 集合类型属性的校验器 * *

- * 内置集合相关的校验规则。 + * 用于构建校验集合类型属性的规则链。 * + * @param 待校验对象的类型 + * @param 集合元素的类型 * @author ZhouXY */ public class CollectionPropertyValidator @@ -46,7 +48,7 @@ public class CollectionPropertyValidator /** * 添加一条校验属性的规则，校验属性是否非空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator notEmpty() { return withRule(Conditions.notEmpty(), "The input must not be empty."); @@ -56,7 +58,7 @@ public class CollectionPropertyValidator * 添加一条校验属性的规则，校验属性是否非空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator notEmpty(final String errorMessage) { return withRule(Conditions.notEmpty(), errorMessage); @@ -67,7 +69,7 @@ public class CollectionPropertyValidator * * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator notEmpty( final Supplier exceptionSupplier) { @@ -79,7 +81,7 @@ public class CollectionPropertyValidator * * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator notEmpty( final Function, X> exceptionFunction) { @@ -97,7 +99,7 @@ public class CollectionPropertyValidator /** * 添加一条校验属性的规则，校验属性是否为空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator isEmpty() { return withRule(Conditions.isEmpty(), "The input must be empty."); @@ -107,7 +109,7 @@ public class CollectionPropertyValidator * 添加一条校验属性的规则，校验属性是否为空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator isEmpty( final String errorMessage) { @@ -117,8 +119,9 @@ public class CollectionPropertyValidator /** * 添加一条校验属性的规则，校验属性是否为空 * + * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator isEmpty( final Supplier exceptionSupplier) { @@ -128,8 +131,9 @@ public class CollectionPropertyValidator /** * 添加一条校验属性的规则，校验属性是否为空 * + * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator isEmpty( final Function, X> exceptionFunction) { @@ -145,10 +149,10 @@ public class CollectionPropertyValidator // ================================ /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * * @param condition 校验条件 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator allMatch( final Predicate condition) { @@ -160,11 +164,10 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 - * - * @param condition 校验规则 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 + * @param condition 校验条件 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator allMatch( final Predicate condition, final String errorMessage) { @@ -176,11 +179,12 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * + * @param 自定义异常类型 * @param condition 校验条件 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator allMatch( final Predicate condition, final Supplier exceptionSupplier) { @@ -192,11 +196,12 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验是否所有元素都满足条件 + * 添加一条校验属性的规则，校验是否所有元素都满足指定条件 * + * @param 自定义异常类型 * @param condition 校验条件 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator allMatch( final Predicate condition, final Function exceptionFunction) { @@ -216,11 +221,11 @@ public class CollectionPropertyValidator // ================================ /** - * 添加一条校验属性的规则，校验属性大小是否等于指定大小 + * 添加一条校验属性的规则，校验集合大小 * - * @param size 指定大小 + * @param size 预期集合大小 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator size( final int size, final String errorMessage) { @@ -228,12 +233,12 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验属性大小是否等于指定大小 + * 添加一条校验属性的规则，校验集合大小 * - * @param 异常类型 - * @param size 指定大小 + * @param 自定义异常类型 + * @param size 预期集合大小 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator size( final int size, final Supplier exceptionSupplier) { @@ -241,12 +246,12 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验属性大小是否等于指定大小 + * 添加一条校验属性的规则，校验集合大小 * - * @param 异常类型 - * @param size 指定大小 + * @param 自定义异常类型 + * @param size 预期集合大小 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator size( final int size, final Function, X> exceptionFunction) { @@ -254,12 +259,12 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验属性的大小范围 + * 添加一条校验属性的规则，校验集合大小是否在指定范围内 * - * @param min 最小大小 - * @param max 最大大小 + * @param min 最小大小（包含） + * @param max 最大大小（包含） * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator size( final int min, final int max, final String errorMessage) { @@ -267,12 +272,13 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验属性的大小范围 + * 添加一条校验属性的规则，校验集合大小是否在指定范围内 * - * @param min 最小大小 - * @param max 最大大小 + * @param 自定义异常类型 + * @param min 最小大小（包含） + * @param max 最大大小（包含） * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator size( final int min, final int max, final Supplier exceptionSupplier) { @@ -280,12 +286,13 @@ public class CollectionPropertyValidator } /** - * 添加一条校验属性的规则，校验属性的大小范围 + * 添加一条校验属性的规则，校验集合大小是否在指定范围内 * - * @param min 最小大小 - * @param max 最大大小 + * @param 自定义异常类型 + * @param min 最小大小（包含） + * @param max 最大大小（包含） * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final CollectionPropertyValidator size( final int min, final int max, final Function, X> exceptionFunction) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ComparablePropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ComparablePropertyValidator.java index 753840c..9cd8d7c 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ComparablePropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ComparablePropertyValidator.java @@ -19,13 +19,11 @@ package xyz.zhouxy.plusone.validator; import java.util.function.Function; /** - * 针对 {@code Comparable} 类型的默认属性校验器 + * {@code Comparable} 类型属性的校验器 * - *

- * 继承自 {@link BaseComparablePropertyValidator}，内置了判断属性是否在给定区间内的校验规则。 - * - * @param 待校验对象类型 - * @param 属性类型 + * @param 待校验对象的类型 + * @param 待校验属性的类型，必须实现 {@code Comparable} 接口 + * @param 具体校验器类型，用于支持链式调用 * @see com.google.common.collect.Range * @author ZhouXY */ diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/DoublePropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/DoublePropertyValidator.java index 0ea90b6..4464835 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/DoublePropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/DoublePropertyValidator.java @@ -21,11 +21,12 @@ import java.util.function.Predicate; import java.util.function.Supplier; /** - * 浮点数属性校验器 + * {@code Double} 类型属性的校验器 * *

- * 内置对 {@code Double} 类型常用的校验规则。 + * 用于构建校验 {@code Double} 类型属性的规则链。 * + * @param 待校验对象的类型 * @author ZhouXY */ public class DoublePropertyValidator @@ -43,7 +44,7 @@ public class DoublePropertyValidator * 添加一条校验属性的规则，校验属性是否大于给定值 * * @param min 最小值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator gt(final double min) { return withRule(Conditions.greaterThan(min), @@ -55,7 +56,7 @@ public class DoublePropertyValidator * * @param min 最小值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator gt( final double min, final String errorMessage) { @@ -65,10 +66,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator gt( final double min, final Supplier exceptionSupplier) { @@ -78,10 +79,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator gt( final double min, final Function exceptionFunction) { @@ -100,7 +101,7 @@ public class DoublePropertyValidator * 添加一条校验属性的规则，校验属性是否大于等于给定值 * * @param min 最小值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator ge(final double min) { return withRule(Conditions.greaterThanOrEqualTo(min), @@ -112,7 +113,7 @@ public class DoublePropertyValidator * * @param min 最小值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator ge( final double min, final String errorMessage) { @@ -122,10 +123,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator ge( final double min, final Supplier exceptionSupplier) { @@ -135,10 +136,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator ge( final double min, final Function exceptionFunction) { @@ -157,7 +158,7 @@ public class DoublePropertyValidator * 添加一条校验属性的规则，校验属性是否小于给定值 * * @param max 最大值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator lt(final double max) { return withRule(Conditions.lessThan(max), @@ -169,7 +170,7 @@ public class DoublePropertyValidator * * @param max 最大值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator lt( final double max, final String errorMessage) { @@ -179,10 +180,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator lt( final double max, final Supplier exceptionSupplier) { @@ -192,10 +193,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator lt( final double max, final Function exceptionFunction) { @@ -214,7 +215,7 @@ public class DoublePropertyValidator * 添加一条校验属性的规则，校验属性是否小于等于给定值 * * @param max 最大值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator le(final double max) { return withRule(Conditions.lessThanOrEqualTo(max), @@ -226,7 +227,7 @@ public class DoublePropertyValidator * * @param max 最大值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator le( final double max, final String errorMessage) { @@ -236,10 +237,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator le( final double max, final Supplier exceptionSupplier) { @@ -249,10 +250,10 @@ public class DoublePropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final DoublePropertyValidator le( final double max, final Function exceptionFunction) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IValidator.java index 79f9be7..a625e12 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IValidator.java @@ -18,14 +18,19 @@ package xyz.zhouxy.plusone.validator; /** * 校验器 * + *

+ * 用于定义对特定类型对象的校验规则 + *

+ * + * @param 待校验对象的类型 * @author ZhouXY */ public interface IValidator { /** - * 校验对象 + * 校验指定对象是否符合预定义规则 * - * @param obj + * @param obj 待校验的对象实例 */ void validate(T obj); } diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IntPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IntPropertyValidator.java index 30bc564..9931f1f 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IntPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/IntPropertyValidator.java @@ -17,15 +17,16 @@ package xyz.zhouxy.plusone.validator; import java.util.function.Function; -import java.util.function.Supplier; import java.util.function.Predicate; +import java.util.function.Supplier; /** - * 整数属性校验器 + * {@code Integer} 类型属性的校验器 * *

- * 内置对 {@code Integer} 类型常用的校验规则。 + * 用于构建校验 {@code Integer} 类型属性的规则链。 * + * @param 待校验对象的类型 * @author ZhouXY */ public class IntPropertyValidator @@ -43,9 +44,9 @@ public class IntPropertyValidator * 添加一条校验属性的规则，校验属性是否大于给定值 * * @param min 最小值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator gt(final int min) { + public final IntPropertyValidator gt(final int min) { return withRule(Conditions.greaterThan(min), "The input must be greater than '%d'.", min); } @@ -55,9 +56,9 @@ public class IntPropertyValidator * * @param min 最小值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator gt( + public final IntPropertyValidator gt( final int min, final String errorMessage) { return withRule(Conditions.greaterThan(min), errorMessage); } @@ -65,12 +66,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator gt( + public final IntPropertyValidator gt( final int min, final Supplier exceptionSupplier) { return withRule(Conditions.greaterThan(min), exceptionSupplier); } @@ -78,12 +79,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator gt( + public final IntPropertyValidator gt( final int min, final Function exceptionFunction) { return withRule(Conditions.greaterThan(min), exceptionFunction); } @@ -100,9 +101,9 @@ public class IntPropertyValidator * 添加一条校验属性的规则，校验属性是否大于等于给定值 * * @param min 最小值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator ge(final int min) { + public final IntPropertyValidator ge(final int min) { return withRule(Conditions.greaterThanOrEqualTo(min), "The input must be greater than or equal to '%d'.", min); } @@ -112,21 +113,21 @@ public class IntPropertyValidator * * @param min 最小值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator ge(final int min, final String errorMessage) { + public final IntPropertyValidator ge(final int min, final String errorMessage) { return withRule(Conditions.greaterThanOrEqualTo(min), errorMessage); } /** * 添加一条校验属性的规则，校验属性是否大于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator ge( + public final IntPropertyValidator ge( final int min, final Supplier exceptionSupplier) { return withRule(Conditions.greaterThanOrEqualTo(min), exceptionSupplier); } @@ -134,12 +135,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator ge( + public final IntPropertyValidator ge( final int min, final Function exceptionFunction) { return withRule(Conditions.greaterThanOrEqualTo(min), exceptionFunction); } @@ -156,9 +157,9 @@ public class IntPropertyValidator * 添加一条校验属性的规则，校验属性是否小于给定值 * * @param max 最大值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator lt(final int max) { + public final IntPropertyValidator lt(final int max) { return withRule(Conditions.lessThan(max), "The input must be less than '%d'.", max); } @@ -168,9 +169,9 @@ public class IntPropertyValidator * * @param max 最大值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator lt( + public final IntPropertyValidator lt( final int max, final String errorMessage) { return withRule(Conditions.lessThan(max), errorMessage); } @@ -178,12 +179,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator lt( + public final IntPropertyValidator lt( final int max, final Supplier exceptionSupplier) { return withRule(Conditions.lessThan(max), exceptionSupplier); } @@ -191,12 +192,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator lt( + public final IntPropertyValidator lt( final int max, final Function exceptionFunction) { return withRule(Conditions.lessThan(max), exceptionFunction); } @@ -213,9 +214,9 @@ public class IntPropertyValidator * 添加一条校验属性的规则，校验属性是否小于等于给定值 * * @param max 最大值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator le(final int max) { + public final IntPropertyValidator le(final int max) { return withRule(Conditions.lessThanOrEqualTo(max), "The input must be less than or equal to '%d'.", max); } @@ -225,9 +226,9 @@ public class IntPropertyValidator * * @param max 最大值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator le( + public final IntPropertyValidator le( final int max, final String errorMessage) { return withRule(Conditions.lessThanOrEqualTo(max), errorMessage); } @@ -235,12 +236,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator le( + public final IntPropertyValidator le( final int max, final Supplier exceptionSupplier) { return withRule(Conditions.lessThanOrEqualTo(max), exceptionSupplier); } @@ -248,12 +249,12 @@ public class IntPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public IntPropertyValidator le( + public final IntPropertyValidator le( final int max, final Function exceptionFunction) { return withRule(Conditions.lessThanOrEqualTo(max), exceptionFunction); } diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/LongPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/LongPropertyValidator.java index c4f8d41..f94b581 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/LongPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/LongPropertyValidator.java @@ -21,11 +21,12 @@ import java.util.function.Predicate; import java.util.function.Supplier; /** - * 长整数属性校验器 + * {@code Long} 类型属性的校验器 * *

- * 内置对 {@code Long} 类型常用的校验规则。 + * 用于构建校验 {@code Long} 类型属性的规则链。 * + * @param 待校验对象的类型 * @author ZhouXY */ public class LongPropertyValidator @@ -43,7 +44,7 @@ public class LongPropertyValidator * 添加一条校验属性的规则，校验属性是否大于给定值 * * @param min 最小值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator gt(final long min) { return withRule(Conditions.greaterThan(min), @@ -55,7 +56,7 @@ public class LongPropertyValidator * * @param min 最小值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator gt( final long min, final String errorMessage) { @@ -65,10 +66,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator gt( final long min, final Supplier exceptionSupplier) { @@ -78,10 +79,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator gt( final long min, final Function exceptionFunction) { @@ -100,7 +101,7 @@ public class LongPropertyValidator * 添加一条校验属性的规则，校验属性是否大于等于给定值 * * @param min 最小值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator ge(final long min) { return withRule(Conditions.greaterThanOrEqualTo(min), @@ -112,20 +113,19 @@ public class LongPropertyValidator * * @param min 最小值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ - public final LongPropertyValidator ge( - final long min, final String errorMessage) { + public final LongPropertyValidator ge(final long min, final String errorMessage) { return withRule(Conditions.greaterThanOrEqualTo(min), errorMessage); } /** * 添加一条校验属性的规则，校验属性是否大于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator ge( final long min, final Supplier exceptionSupplier) { @@ -135,10 +135,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否大于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param min 最小值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator ge( final long min, final Function exceptionFunction) { @@ -157,7 +157,7 @@ public class LongPropertyValidator * 添加一条校验属性的规则，校验属性是否小于给定值 * * @param max 最大值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator lt(final long max) { return withRule(Conditions.lessThan(max), @@ -169,7 +169,7 @@ public class LongPropertyValidator * * @param max 最大值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator lt( final long max, final String errorMessage) { @@ -179,10 +179,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator lt( final long max, final Supplier exceptionSupplier) { @@ -192,10 +192,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator lt( final long max, final Function exceptionFunction) { @@ -214,7 +214,7 @@ public class LongPropertyValidator * 添加一条校验属性的规则，校验属性是否小于等于给定值 * * @param max 最大值 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator le(final long max) { return withRule(Conditions.lessThanOrEqualTo(max), @@ -226,7 +226,7 @@ public class LongPropertyValidator * * @param max 最大值 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator le( final long max, final String errorMessage) { @@ -236,10 +236,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator le( final long max, final Supplier exceptionSupplier) { @@ -249,10 +249,10 @@ public class LongPropertyValidator /** * 添加一条校验属性的规则，校验属性是否小于等于给定值 * - * @param 异常类型 + * @param 自定义异常类型 * @param max 最大值 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前验证器实例，用于链式调用 */ public final LongPropertyValidator le( final long max, final Function exceptionFunction) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ObjectPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ObjectPropertyValidator.java index 9445ce1..7112e2d 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ObjectPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ObjectPropertyValidator.java @@ -21,6 +21,8 @@ import java.util.function.Function; /** * 通用类型属性校验器。继承自 {@link BasePropertyValidator}，包含针对属性的校验规则。 * + * @param 待校验对象的类型 + * @param 待校验属性的类型 * @author ZhouXY */ public class ObjectPropertyValidator diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/PairPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/PairPropertyValidator.java index 0bb8652..e861cc2 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/PairPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/PairPropertyValidator.java @@ -24,6 +24,9 @@ import java.util.function.Supplier; /** * 针对二元组的属性校验器 * + * @param 被验证对象类型 + * @param 第一个元素的类型 + * @param 第二个元素的类型 * @author ZhouXY */ public class PairPropertyValidator @@ -57,6 +60,7 @@ public class PairPropertyValidator /** * 添加一条校验属性的规则，校验二元组是否满足给定的条件 * + * @param 自定义异常类型 * @param condition 校验条件 * @param exceptionSupplier 自定义异常 * @return 属性校验器 @@ -66,9 +70,10 @@ public class PairPropertyValidator return must(pair -> condition.test(pair.getKey(), pair.getValue()), exceptionSupplier); } - /** + /** * 添加一条校验属性的规则，校验二元组是否满足给定的条件 * + * @param 自定义异常类型 * @param condition 校验条件 * @param exceptionFunction 自定义异常 * @return 属性校验器 diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/StringPropertyValidator.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/StringPropertyValidator.java index 317aadc..cb8be10 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/StringPropertyValidator.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/StringPropertyValidator.java @@ -29,8 +29,12 @@ import xyz.zhouxy.plusone.commons.util.RegexTools; import xyz.zhouxy.plusone.commons.util.StringTools; /** - * 针对文本类型的属性校验器。 + * {@code String} 类型属性的校验器 * + *

+ * 用于构建校验 {@code String} 类型属性的规则链。 + * + * @param 待校验对象的类型 * @author ZhouXY */ public class StringPropertyValidator @@ -49,7 +53,7 @@ public class StringPropertyValidator * * @param pattern 正则表达式 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matches( final Pattern pattern, final String errorMessage) { @@ -59,10 +63,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否匹配正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param pattern 正则表达式 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public StringPropertyValidator matches( final Pattern pattern, final Supplier exceptionSupplier) { @@ -72,10 +76,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否匹配正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param pattern 正则表达式 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matches( final Pattern pattern, final Function exceptionFunction) { @@ -91,11 +95,11 @@ public class StringPropertyValidator // ================================ /** - * 添加一条校验属性的规则，校验属性是否匹配指定的多个正则表达式的其中一个 + * 添加一条校验属性的规则，校验属性是否匹配指定的任一正则表达式 * * @param patterns 正则表达式 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAny( final Pattern[] patterns, final String errorMessage) { @@ -103,12 +107,12 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否匹配指定的多个正则表达式的其中一个 + * 添加一条校验属性的规则，校验属性是否匹配指定的任一正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAny( final Pattern[] patterns, final Supplier exceptionSupplier) { @@ -116,12 +120,12 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否匹配指定的多个正则表达式的其中一个 + * 添加一条校验属性的规则，校验属性是否匹配指定的任一正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAny( final Pattern[] patterns, final Function exceptionFunction) { @@ -129,11 +133,11 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否匹配指定的多个正则表达式的其中一个 + * 添加一条校验属性的规则，校验属性是否匹配指定的任一正则表达式 * * @param patterns 正则表达式 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAny( final Collection patterns, final String errorMessage) { @@ -141,12 +145,12 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否匹配指定的多个正则表达式的其中一个 + * 添加一条校验属性的规则，校验属性是否匹配指定的任一正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAny( final Collection patterns, final Supplier exceptionSupplier) { @@ -154,12 +158,12 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否匹配指定的多个正则表达式的其中一个 + * 添加一条校验属性的规则，校验属性是否匹配指定的任一正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAny( final Collection patterns, final Function exceptionFunction) { @@ -179,7 +183,7 @@ public class StringPropertyValidator * * @param patterns 正则表达式 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAll( final Pattern[] patterns, final String errorMessage) { @@ -189,10 +193,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否匹配指定的所有正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAll( final Pattern[] patterns, final Supplier exceptionSupplier) { @@ -202,10 +206,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否匹配指定的所有正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAll( final Pattern[] patterns, final Function exceptionFunction) { @@ -217,7 +221,7 @@ public class StringPropertyValidator * * @param patterns 正则表达式 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAll( final Collection patterns, final String errorMessage) { @@ -227,10 +231,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否匹配指定的所有正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAll( final Collection patterns, final Supplier exceptionSupplier) { @@ -240,10 +244,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否匹配指定的所有正则表达式 * - * @param 异常类型 + * @param 自定义异常类型 * @param patterns 正则表达式 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator matchesAll( final Collection patterns, final Function exceptionFunction) { @@ -261,7 +265,7 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否不为空白字符串 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notBlank() { return withRule(Conditions.notBlank(), @@ -272,7 +276,7 @@ public class StringPropertyValidator * 添加一条校验属性的规则，校验属性是否不为空白字符串 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notBlank(final String errorMessage) { return withRule(Conditions.notBlank(), errorMessage); @@ -281,9 +285,9 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否不为空白字符串 * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notBlank( final Supplier exceptionSupplier) { @@ -293,9 +297,9 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性是否不为空白字符串 * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notBlank( final Function exceptionFunction) { @@ -311,9 +315,9 @@ public class StringPropertyValidator // ================================ /** - * 添加一条校验属性的规则，校验属性是否是邮箱地址 + * 添加一条校验属性的规则，校验属性是否满足邮箱格式 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator emailAddress() { return withRule(Conditions.emailAddress(), @@ -321,21 +325,21 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否是邮箱地址 + * 添加一条校验属性的规则，校验属性是否满足邮箱格式 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator emailAddress(final String errorMessage) { return withRule(Conditions.emailAddress(), errorMessage); } /** - * 添加一条校验属性的规则，校验属性是否是邮箱地址 + * 添加一条校验属性的规则，校验属性是否满足邮箱格式 * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator emailAddress( final Supplier exceptionSupplier) { @@ -343,11 +347,11 @@ public class StringPropertyValidator } /** - * 添加一条校验属性的规则，校验属性是否是邮箱地址 + * 添加一条校验属性的规则，校验属性是否满足邮箱格式 * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator emailAddress( final Function exceptionFunction) { @@ -365,7 +369,7 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验字符串属性是否不为空 * - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notEmpty() { return withRule(Conditions.notEmpty(), @@ -376,7 +380,7 @@ public class StringPropertyValidator * 添加一条校验属性的规则，校验字符串属性是否不为空 * * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notEmpty(final String errorMessage) { return withRule(Conditions.notEmpty(), errorMessage); @@ -385,9 +389,9 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验字符串属性是否不为空 * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notEmpty( final Supplier exceptionSupplier) { @@ -397,9 +401,9 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验字符串属性是否不为空 * - * @param 异常类型 + * @param 自定义异常类型 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator notEmpty( final Function exceptionFunction) { @@ -419,7 +423,7 @@ public class StringPropertyValidator * * @param length 指定长度 * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator length( final int length, final String errorMessage) { @@ -429,10 +433,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性长度是否等于指定长度 * - * @param 异常类型 + * @param 自定义异常类型 * @param length 指定长度 * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator length( final int length, final Supplier exceptionSupplier) { @@ -442,10 +446,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性长度是否等于指定长度 * - * @param 异常类型 + * @param 自定义异常类型 * @param length 指定长度 * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator length( final int length, final Function exceptionFunction) { @@ -455,10 +459,10 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性的长度范围 * - * @param min 最小长度 - * @param max 最大长度 + * @param min 最小长度（包含） + * @param max 最大长度（包含） * @param errorMessage 异常信息 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator length( final int min, final int max, final String errorMessage) { @@ -468,11 +472,11 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性的长度范围 * - * @param 异常类型 - * @param min 最小长度 - * @param max 最大长度 + * @param 自定义异常类型 + * @param min 最小长度（包含） + * @param max 最大长度（包含） * @param exceptionSupplier 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator length( final int min, final int max, final Supplier exceptionSupplier) { @@ -482,11 +486,11 @@ public class StringPropertyValidator /** * 添加一条校验属性的规则，校验属性的长度范围 * - * @param 异常类型 - * @param min 最小长度 - * @param max 最大长度 + * @param 自定义异常类型 + * @param min 最小长度（包含） + * @param max 最大长度（包含） * @param exceptionFunction 自定义异常 - * @return 属性校验器 + * @return 当前校验器实例，用于链式调用 */ public final StringPropertyValidator length( final int min, final int max, final Function exceptionFunction) { diff --git a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ValidationException.java b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ValidationException.java index 70b065f..53f706a 100644 --- a/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ValidationException.java +++ b/plusone-validator/src/main/java/xyz/zhouxy/plusone/validator/ValidationException.java @@ -16,7 +16,7 @@ package xyz.zhouxy.plusone.validator; /** - * 验证失败的异常 + * 校验失败异常 * * @author ZhouXY */ @@ -39,51 +39,51 @@ public class ValidationException extends RuntimeException { } /** - * 创建一个验证失败异常 + * 创建 {@code ValidationException} 实例 * - * @return 异常 + * @return {@code ValidationException} 实例 */ public static ValidationException withDefaultMessage() { return new ValidationException(DEFAULT_MESSAGE); } /** - * 创建一个验证失败异常 + * 创建 {@code ValidationException} 实例 * - * @param message 错误信息 - * @return 异常 + * @param message 异常信息 + * @return {@code ValidationException} 实例 */ public static ValidationException withMessage(String message) { return new ValidationException(message); } /** - * 创建一个验证失败异常 + * 创建 {@code ValidationException} 实例 * - * @param errorMessageTemplate 异常信息模版 - * @param errorMessageArgs 异常信息参数 - * @return 异常 + * @param errorMessageTemplate 异常信息模板 + * @param errorMessageArgs 异常信息参数列表 + * @return {@code ValidationException} 实例 */ public static ValidationException withMessage(String errorMessageTemplate, Object... errorMessageArgs) { return new ValidationException(String.format(errorMessageTemplate, errorMessageArgs)); } /** - * 创建一个验证失败异常 + * 创建 {@code ValidationException} 实例 * - * @param cause 错误 cause - * @return 异常 + * @param cause 导致校验失败的根本异常 + * @return {@code ValidationException} 实例 */ public static ValidationException withCause(Throwable cause) { return new ValidationException(cause); } /** - * 创建一个验证失败异常 + * 创建 {@code ValidationException} 实例 * - * @param message 错误信息 - * @param cause 错误 cause - * @return 异常 + * @param message 异常信息 + * @param cause 导致校验失败的根本异常 + * @return {@code ValidationException} 实例 */ public static ValidationException withMessageAndCause(String message, Throwable cause) { return new ValidationException(message, cause);