cn.buli_home.utils.common.Assert Maven / Gradle / Ivy
The newest version!
package cn.buli_home.utils.common;
import java.util.Map;
import java.util.Objects;
import java.util.function.Supplier;
public class Assert {
private static final String TEMPLATE_VALUE_MUST_BE_BETWEEN_AND = "The value must be between {} and {}.";
/**
* 断言是否为真，如果为 {@code false} 抛出给定的异常
*
*
* Assert.isTrue(i > 0, IllegalArgumentException::new);
*
*
* @param 异常类型
* @param expression 布尔值
* @param supplier 指定断言不通过时抛出的异常
* @throws X if expression is {@code false}
*/
public static void isTrue(boolean expression, Supplier supplier) throws X {
if (!expression) {
throw supplier.get();
}
}
/**
* 断言是否为真，如果为 {@code false} 抛出 {@code IllegalArgumentException} 异常
*
*
* Assert.isTrue(i > 0, "The value must be greater than zero");
*
*
* @param expression 布尔值
* @param errorMsgTemplate 错误抛出异常附带的消息模板，变量用{}代替
* @param params 参数列表
* @throws IllegalArgumentException if expression is {@code false}
*/
public static void isTrue(boolean expression, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
isTrue(expression, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言是否为真，如果为 {@code false} 抛出 {@code IllegalArgumentException} 异常
*
*
* Assert.isTrue(i > 0);
*
*
* @param expression 布尔值
* @throws IllegalArgumentException if expression is {@code false}
*/
public static void isTrue(boolean expression) throws IllegalArgumentException {
isTrue(expression, "[Assertion failed] - this expression must be true");
}
/**
* 断言是否为假，如果为 {@code true} 抛出指定类型异常
* 并使用指定的函数获取错误信息返回
*
* Assert.isFalse(i > 0, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param 异常类型
* @param expression 布尔值
* @param errorSupplier 指定断言不通过时抛出的异常
* @throws X if expression is {@code false}
*/
public static void isFalse(boolean expression, Supplier errorSupplier) throws X {
if (expression) {
throw errorSupplier.get();
}
}
/**
* 断言是否为假，如果为 {@code true} 抛出 {@code IllegalArgumentException} 异常
*
*
* Assert.isFalse(i < 0, "The value must not be negative");
*
*
* @param expression 布尔值
* @param errorMsgTemplate 错误抛出异常附带的消息模板，变量用{}代替
* @param params 参数列表
* @throws IllegalArgumentException if expression is {@code false}
*/
public static void isFalse(boolean expression, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
isFalse(expression, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言是否为假，如果为 {@code true} 抛出 {@code IllegalArgumentException} 异常
*
*
* Assert.isFalse(i < 0);
*
*
* @param expression 布尔值
* @throws IllegalArgumentException if expression is {@code false}
*/
public static void isFalse(boolean expression) throws IllegalArgumentException {
isFalse(expression, "[Assertion failed] - this expression must be false");
}
/**
* 断言对象是否为{@code null} ，如果不为{@code null} 抛出指定类型异常
* 并使用指定的函数获取错误信息返回
*
* Assert.isNull(value, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param 异常类型
* @param object 被检查的对象
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @throws X if the object is not {@code null}
*/
public static void isNull(Object object, Supplier errorSupplier) throws X {
if (null != object) {
throw errorSupplier.get();
}
}
/**
* 断言对象是否为{@code null} ，如果不为{@code null} 抛出{@link IllegalArgumentException} 异常
*
*
* Assert.isNull(value, "The value must be null");
*
*
* @param object 被检查的对象
* @param errorMsgTemplate 消息模板，变量使用{}表示
* @param params 参数列表
* @throws IllegalArgumentException if the object is not {@code null}
*/
public static void isNull(Object object, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
isNull(object, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言对象是否为{@code null} ，如果不为{@code null} 抛出{@link IllegalArgumentException} 异常
*
*
* Assert.isNull(value);
*
*
* @param object 被检查对象
* @throws IllegalArgumentException if the object is not {@code null}
*/
public static void isNull(Object object) throws IllegalArgumentException {
isNull(object, "[Assertion failed] - the object argument must be null");
}
// ----------------------------------------------------------------------------------------------------------- Check not null
/**
* 断言对象是否不为{@code null} ，如果为{@code null} 抛出指定类型异常
* 并使用指定的函数获取错误信息返回
*
* Assert.notNull(clazz, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param 被检查对象泛型类型
* @param 异常类型
* @param object 被检查对象
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @return 被检查后的对象
* @throws X if the object is {@code null}
*/
public static T notNull(T object, Supplier errorSupplier) throws X {
if (null == object) {
throw errorSupplier.get();
}
return object;
}
/**
* 断言对象是否不为{@code null} ，如果为{@code null} 抛出{@link IllegalArgumentException} 异常 Assert that an object is not {@code null} .
*
*
* Assert.notNull(clazz, "The class must not be null");
*
*
* @param 被检查对象泛型类型
* @param object 被检查对象
* @param errorMsgTemplate 错误消息模板，变量使用{}表示
* @param params 参数
* @return 被检查后的对象
* @throws IllegalArgumentException if the object is {@code null}
*/
public static T notNull(T object, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return notNull(object, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言对象是否不为{@code null} ，如果为{@code null} 抛出{@link IllegalArgumentException} 异常
*
*
* Assert.notNull(clazz);
*
*
* @param 被检查对象类型
* @param object 被检查对象
* @return 非空对象
* @throws IllegalArgumentException if the object is {@code null}
*/
public static T notNull(T object) throws IllegalArgumentException {
return notNull(object, "[Assertion failed] - this argument is required; it must not be null");
}
// ----------------------------------------------------------------------------------------------------------- Check empty
/**
* 检查给定字符串是否为空，为空抛出自定义异常，并使用指定的函数获取错误信息返回。
*
* Assert.notEmpty(name, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param 异常类型
* @param 字符串类型
* @param text 被检查字符串
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @return 非空字符串
* @throws X 被检查字符串为空抛出此异常
*/
public static T notEmpty(T text, Supplier errorSupplier) throws X {
if (StringUtils.isEmpty(text)) {
throw errorSupplier.get();
}
return text;
}
/**
* 检查给定字符串是否为空，为空抛出 {@link IllegalArgumentException}
*
*
* Assert.notEmpty(name, "Name must not be empty");
*
*
* @param 字符串类型
* @param text 被检查字符串
* @param errorMsgTemplate 错误消息模板，变量使用{}表示
* @param params 参数
* @return 非空字符串
* @throws IllegalArgumentException 被检查字符串为空
*/
public static T notEmpty(T text, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return notEmpty(text, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 检查给定字符串是否为空，为空抛出 {@link IllegalArgumentException}
*
*
* Assert.notEmpty(name);
*
*
* @param 字符串类型
* @param text 被检查字符串
* @return 被检查的字符串
* @throws IllegalArgumentException 被检查字符串为空
*/
public static T notEmpty(T text) throws IllegalArgumentException {
return notEmpty(text, "[Assertion failed] - this String argument must have length; it must not be null or empty");
}
/**
* 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出自定义异常。
* 并使用指定的函数获取错误信息返回
*
* Assert.notBlank(name, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param 异常类型
* @param 字符串类型
* @param text 被检查字符串
* @param errorMsgSupplier 错误抛出异常附带的消息生产接口
* @return 非空字符串
* @throws X 被检查字符串为空白
* @see StringUtils#isEmpty(CharSequence)
*/
public static T notBlank(T text, Supplier errorMsgSupplier) throws X {
if (StringUtils.isEmpty(text)) {
throw errorMsgSupplier.get();
}
return text;
}
/**
* 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 {@link IllegalArgumentException}
*
*
* Assert.notBlank(name, "Name must not be blank");
*
*
* @param 字符串类型
* @param text 被检查字符串
* @param errorMsgTemplate 错误消息模板，变量使用{}表示
* @param params 参数
* @return 非空字符串
* @throws IllegalArgumentException 被检查字符串为空白
*/
public static T notBlank(T text, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return notBlank(text, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 {@link IllegalArgumentException}
*
*
* Assert.notBlank(name);
*
*
* @param 字符串类型
* @param text 被检查字符串
* @return 非空字符串
* @throws IllegalArgumentException 被检查字符串为空白
*/
public static T notBlank(T text) throws IllegalArgumentException {
return notBlank(text, "[Assertion failed] - this String argument must have text; it must not be null, empty, or blank");
}
/**
* 断言给定字符串是否不被另一个字符串包含（即是否为子串）
* 并使用指定的函数获取错误信息返回
*
* Assert.notContain(name, "rod", ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return ");
* });
*
*
* @param 字符串类型
* @param 异常类型
* @param textToSearch 被搜索的字符串
* @param substring 被检查的子串
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @return 被检查的子串
* @throws X 非子串抛出异常
*/
public static T notContain(CharSequence textToSearch, T substring, Supplier errorSupplier) throws X {
if (textToSearch.toString().contains(substring)) {
throw errorSupplier.get();
}
return substring;
}
/**
* 断言给定字符串是否不被另一个字符串包含（即是否为子串）
*
*
* Assert.notContain(name, "rod", "Name must not contain 'rod'");
*
*
* @param textToSearch 被搜索的字符串
* @param substring 被检查的子串
* @param errorMsgTemplate 异常时的消息模板
* @param params 参数列表
* @return 被检查的子串
* @throws IllegalArgumentException 非子串抛出异常
*/
public static String notContain(String textToSearch, String substring, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return notContain(textToSearch, substring, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言给定字符串是否不被另一个字符串包含（即是否为子串）
*
*
* Assert.notContain(name, "rod");
*
*
* @param textToSearch 被搜索的字符串
* @param substring 被检查的子串
* @return 被检查的子串
* @throws IllegalArgumentException 非子串抛出异常
*/
public static String notContain(String textToSearch, String substring) throws IllegalArgumentException {
return notContain(textToSearch, substring, "[Assertion failed] - this String argument must not contain the substring [{}]", substring);
}
/**
* 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素
* 并使用指定的函数获取错误信息返回
*
*
* Assert.notEmpty(array, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param 数组元素类型
* @param 异常类型
* @param array 被检查的数组
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @return 被检查的数组
* @throws X if the object array is {@code null} or has no elements
* @see ArrayUtils#isNotEmpty(Object[])
*/
public static T[] notEmpty(T[] array, Supplier errorSupplier) throws X {
if (ArrayUtils.isEmpty(array)) {
throw errorSupplier.get();
}
return array;
}
/**
* 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素
*
*
* Assert.notEmpty(array, "The array must have elements");
*
*
* @param 数组元素类型
* @param array 被检查的数组
* @param errorMsgTemplate 异常时的消息模板
* @param params 参数列表
* @return 被检查的数组
* @throws IllegalArgumentException if the object array is {@code null} or has no elements
*/
public static T[] notEmpty(T[] array, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return notEmpty(array, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素
*
*
* Assert.notEmpty(array, "The array must have elements");
*
*
* @param 数组元素类型
* @param array 被检查的数组
* @return 被检查的数组
* @throws IllegalArgumentException if the object array is {@code null} or has no elements
*/
public static T[] notEmpty(T[] array) throws IllegalArgumentException {
return notEmpty(array, "[Assertion failed] - this array must not be empty: it must contain at least 1 element");
}
/**
* 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含
* 并使用指定的函数获取错误信息返回
*
* Assert.noNullElements(array, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return ");
* });
*
*
* @param 数组元素类型
* @param 异常类型
* @param array 被检查的数组
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @return 被检查的数组
* @throws X if the object array contains a {@code null} element
* @see ArrayUtils#hasNull(Object[])
*/
public static T[] noNullElements(T[] array, Supplier errorSupplier) throws X {
if (ArrayUtils.hasNull(array)) {
throw errorSupplier.get();
}
return array;
}
/**
* 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含
*
*
* Assert.noNullElements(array, "The array must not have null elements");
*
*
* @param 数组元素类型
* @param array 被检查的数组
* @param errorMsgTemplate 异常时的消息模板
* @param params 参数列表
* @return 被检查的数组
* @throws IllegalArgumentException if the object array contains a {@code null} element
*/
public static T[] noNullElements(T[] array, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return noNullElements(array, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含
*
*
* Assert.noNullElements(array);
*
*
* @param 数组元素类型
* @param array 被检查的数组
* @return 被检查的数组
* @throws IllegalArgumentException if the object array contains a {@code null} element
*/
public static T[] noNullElements(T[] array) throws IllegalArgumentException {
return noNullElements(array, "[Assertion failed] - this array must not contain any null elements");
}
/**
* 断言给定Map非空
* 并使用指定的函数获取错误信息返回
*
* Assert.notEmpty(map, ()->{
* // to query relation message
* return new IllegalArgumentException("relation message to return");
* });
*
*
* @param Key类型
* @param Value类型
* @param Map类型
* @param 异常类型
* @param map 被检查的Map
* @param errorSupplier 错误抛出异常附带的消息生产接口
* @return 被检查的Map
* @throws X if the map is {@code null} or has no entries
* @see MapUtils#isEmpty(Map)
*/
public static , X extends Throwable> T notEmpty(T map, Supplier errorSupplier) throws X {
if (MapUtils.isEmpty(map)) {
throw errorSupplier.get();
}
return map;
}
/**
* 断言给定Map非空
*
*
* Assert.notEmpty(map, "Map must have entries");
*
*
* @param Key类型
* @param Value类型
* @param Map类型
* @param map 被检查的Map
* @param errorMsgTemplate 异常时的消息模板
* @param params 参数列表
* @return 被检查的Map
* @throws IllegalArgumentException if the map is {@code null} or has no entries
*/
public static > T notEmpty(T map, String errorMsgTemplate, Object... params) throws IllegalArgumentException {
return notEmpty(map, () -> new IllegalArgumentException(StringFormatter.format(errorMsgTemplate, params)));
}
/**
* 断言给定Map非空
*
*
* Assert.notEmpty(map, "Map must have entries");
*
*
* @param Key类型
* @param Value类型
* @param Map类型
* @param map 被检查的Map
* @return 被检查的Map
* @throws IllegalArgumentException if the map is {@code null} or has no entries
*/
public static > T notEmpty(T map) throws IllegalArgumentException {
return notEmpty(map, "[Assertion failed] - this map must not be empty; it must contain at least one entry");
}
/**
* 断言给定对象是否是给定类的实例
*
*
* Assert.instanceOf(Foo.class, foo);
*
*
* @param 被检查对象泛型类型
* @param type 被检查对象匹配的类型
* @param obj 被检查对象
* @return 被检查的对象
* @throws IllegalArgumentException if the object is not an instance of clazz
* @see Class#isInstance(Object)
*/
public static T isInstanceOf(Class type, T obj) {
return isInstanceOf(type, obj, "Object [{}] is not instanceof [{}]", obj, type);
}
/**
* 断言给定对象是否是给定类的实例
*
*
* Assert.instanceOf(Foo.class, foo, "foo must be an instance of class Foo");
*
*
* @param