docs: 更新 BasePropertyValidator 类的 Javadoc 文档

- 为 `equal` 和 `notEqual` 方法添加 `null` 值处理说明,明确当值为 `null` 时视为通过
- 在所有相关方法中添加 `notNull()` 方法的引用提示
This commit is contained in:
2026-05-27 11:09:54 +08:00
parent edeaec85da
commit e22a95861d

View File

@@ -258,6 +258,9 @@ public abstract class BasePropertyValidator<
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param obj 用于比较的对象
* @return 当前校验器实例,用于链式调用
*/
@@ -269,6 +272,9 @@ public abstract class BasePropertyValidator<
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param obj 用于比较的对象
* @param errorMessage 异常信息
* @return 当前校验器实例,用于链式调用
@@ -281,6 +287,9 @@ public abstract class BasePropertyValidator<
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param <X> 自定义异常类型
* @param obj 用于比较的对象
* @param exceptionSupplier 自定义异常
@@ -294,6 +303,9 @@ public abstract class BasePropertyValidator<
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param <X> 自定义异常类型
* @param obj 用于比较的对象
* @param exceptionFunction 自定义异常
@@ -313,7 +325,10 @@ public abstract class BasePropertyValidator<
// ================================
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param obj 用于比较的对象
* @return 当前校验器实例,用于链式调用
@@ -324,7 +339,10 @@ public abstract class BasePropertyValidator<
}
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param obj 用于比较的对象
* @param errorMessage 异常信息
@@ -335,7 +353,10 @@ public abstract class BasePropertyValidator<
}
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param <X> 自定义异常类型
* @param obj 用于比较的对象
@@ -348,7 +369,10 @@ public abstract class BasePropertyValidator<
}
/**
* 添加一条校验属性的规则,校验属性是否等于给定值
* 添加一条校验属性的规则,校验属性是否等于给定值
*
* <p>
* 当值为 {@code null} 时,视为通过。如果需要校验值不为 {@code null},请使用 {@link #notNull()} 方法。
*
* @param <X> 自定义异常类型
* @param obj 用于比较的对象