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 super TProperty> 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 super TProperty> condition,
@@ -84,9 +88,10 @@ public abstract class BasePropertyValidator<
/**
* 添加一条校验属性的规则
*
+ * @param 自定义异常类型
* @param condition 校验条件
* @param exceptionSupplier 自定义异常
- * @return 属性校验器
+ * @return 当前校验器实例,用于链式调用
*/
protected final TPropertyValidator withRule(
final Predicate super TProperty> condition,
@@ -99,11 +104,12 @@ public abstract class BasePropertyValidator<
}
/**
- * 添加一条校验属性的规则
+ * 添加一条校验属性的规则,当条件不满足时抛出自定义异常。可以根据当前属性的值创建异常。
*
+ * @param 自定义异常类型
* @param condition 校验条件
- * @param exceptionFunction 自定义异常
- * @return 属性校验器
+ * @param exceptionFunction 自定义异常(以当前属性值为参数)
+ * @return 当前校验器实例,用于链式调用
*/
protected final TPropertyValidator withRule(
final Predicate super TProperty> condition,
@@ -118,8 +124,8 @@ public abstract class BasePropertyValidator<
/**
* 添加一条校验属性的规则
*
- * @param rule 校验规则
- * @return 属性校验器
+ * @param rule 自定义校验规则
+ * @return 当前校验器实例,用于链式调用
*/
protected final TPropertyValidator withRule(Consumer super TProperty> 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 super TProperty> condition) {
return withRule(condition,
@@ -378,7 +384,7 @@ public abstract class BasePropertyValidator<
*
* @param condition 校验条件
* @param errorMessage 异常信息
- * @return 属性校验器
+ * @return 当前校验器实例,用于链式调用
*/
public final TPropertyValidator must(
final Predicate super TProperty> condition,
@@ -392,7 +398,7 @@ public abstract class BasePropertyValidator<
* @param 自定义异常类型
* @param condition 校验规则
* @param exceptionSupplier 自定义异常
- * @return 属性校验器
+ * @return 当前校验器实例,用于链式调用
*/
public final TPropertyValidator must(
final Predicate super TProperty> condition,
@@ -406,7 +412,7 @@ public abstract class BasePropertyValidator<
* @param 自定义异常类型
* @param condition 校验规则
* @param exceptionFunction 自定义异常
- * @return 属性校验器
+ * @return 当前校验器实例,用于链式调用
*/
public final TPropertyValidator must(
final Predicate super TProperty> 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 super T> 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