AssertTools (Simple JDBC 1.0.0 API)

java.lang.Object
- xyz.zhouxy.jdbc.util.AssertTools

public class AssertTools
extends Object

断言工具

本工具类不封装过多判断逻辑，鼓励充分使用项目中的工具类进行逻辑判断。

 checkArgument(StringUtils.hasText(str), "The argument cannot be blank.");
 checkState(ArrayUtils.isNotEmpty(result), "The result cannot be empty.");
 checkCondition(!CollectionUtils.isEmpty(roles),
     () -> new InvalidInputException("The roles cannot be empty."));
 checkCondition(RegexTools.matches(email, PatternConsts.EMAIL),
     "must be a well-formed email address");

Author:: ZhouXY

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkArgument(boolean condition)` 检查实参
`static void`	`checkArgument(boolean condition, String errorMessage)` 检查实参
`static void`	`checkArgument(boolean condition, String errorMessageTemplate, Object... errorMessageArgs)` 检查实参
`static void`	`checkArgument(boolean condition, Supplier<String> errorMessageSupplier)` 检查实参
`static <T> T`	`checkArgumentNotNull(T obj)` 判断入参不为 `null`
`static <T> T`	`checkArgumentNotNull(T obj, String errorMessage)` 判断入参不为 `null`
`static <T> T`	`checkArgumentNotNull(T obj, String errorMessageTemplate, Object... errorMessageArgs)` 判断入参不为 `null`
`static <T> T`	`checkArgumentNotNull(T obj, Supplier<String> errorMessageSupplier)` 判断入参不为 `null`
`static <T extends Exception> void`	`checkCondition(boolean condition, Supplier<T> e)` 当条件不满足时抛出异常。
`static <T> void`	`checkNotNull(T obj)` 判空
`static <T> void`	`checkNotNull(T obj, String errorMessage)` 判空
`static <T> void`	`checkNotNull(T obj, String errorMessageTemplate, Object... errorMessageArgs)` 判空
`static <T> void`	`checkNotNull(T obj, Supplier<String> errorMessageSupplier)` 判空
`static void`	`checkState(boolean condition)` 检查状态
`static void`	`checkState(boolean condition, String errorMessage)` 检查状态
`static void`	`checkState(boolean condition, String errorMessageTemplate, Object... errorMessageArgs)` 检查状态
`static void`	`checkState(boolean condition, Supplier<String> errorMessageSupplier)` 检查状态

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - checkArgument
```
public static void checkArgument(boolean condition)
```
    检查实参
    
    Parameters:
    
    condition - 判断参数是否符合条件的结果
    
    Throws:
    
    IllegalArgumentException - 当条件不满足时抛出
  - checkArgument
```
public static void checkArgument(boolean condition,
                                 String errorMessage)
```
    检查实参
    
    Parameters:
    
    condition - 判断参数是否符合条件的结果
    
    errorMessage - 异常信息
    
    Throws:
    
    IllegalArgumentException - 当条件不满足时抛出
  - checkArgument
```
public static void checkArgument(boolean condition,
                                 Supplier<String> errorMessageSupplier)
```
    检查实参
    
    Parameters:
    
    condition - 判断参数是否符合条件的结果
    
    errorMessageSupplier - 异常信息
    
    Throws:
    
    IllegalArgumentException - 当条件不满足时抛出
  - checkArgument
```
public static void checkArgument(boolean condition,
                                 String errorMessageTemplate,
                                 Object... errorMessageArgs)
```
    检查实参
    
    Parameters:
    
    condition - 判断参数是否符合条件的结果
    
    errorMessageTemplate - 异常信息模板
    
    errorMessageArgs - 异常信息参数
    
    Throws:
    
    IllegalArgumentException - 当条件不满足时抛出
  - checkArgumentNotNull
```
public static <T> T checkArgumentNotNull(T obj)
```
    判断入参不为 null
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    Returns:
    
    校验通过时返回入参
    
    Throws:
    
    IllegalArgumentException - 当 obj 为 null 时抛出
  - checkArgumentNotNull
```
public static <T> T checkArgumentNotNull(T obj,
                                         String errorMessage)
```
    判断入参不为 null
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    errorMessage - 异常信息
    
    Returns:
    
    校验通过时返回入参
    
    Throws:
    
    IllegalArgumentException - 当 obj 为 null 时抛出
  - checkArgumentNotNull
```
public static <T> T checkArgumentNotNull(T obj,
                                         Supplier<String> errorMessageSupplier)
```
    判断入参不为 null
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    errorMessageSupplier - 异常信息
    
    Returns:
    
    校验通过时返回入参
    
    Throws:
    
    IllegalArgumentException - 当 obj 为 null 时抛出
  - checkArgumentNotNull
```
public static <T> T checkArgumentNotNull(T obj,
                                         String errorMessageTemplate,
                                         Object... errorMessageArgs)
```
    判断入参不为 null
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    errorMessageTemplate - 异常信息模板
    
    errorMessageArgs - 异常信息参数
    
    Returns:
    
    校验通过时返回入参
    
    Throws:
    
    IllegalArgumentException - 当 obj 为 null 时抛出
  - checkState
```
public static void checkState(boolean condition)
```
    检查状态
    
    Parameters:
    
    condition - 判断状态是否符合条件的结果
    
    Throws:
    
    IllegalStateException - 当条件不满足时抛出
  - checkState
```
public static void checkState(boolean condition,
                              String errorMessage)
```
    检查状态
    
    Parameters:
    
    condition - 判断状态是否符合条件的结果
    
    errorMessage - 异常信息
    
    Throws:
    
    IllegalStateException - 当条件不满足时抛出
  - checkState
```
public static void checkState(boolean condition,
                              Supplier<String> errorMessageSupplier)
```
    检查状态
    
    Parameters:
    
    condition - 判断状态是否符合条件的结果
    
    errorMessageSupplier - 异常信息
    
    Throws:
    
    IllegalStateException - 当条件不满足时抛出
  - checkState
```
public static void checkState(boolean condition,
                              String errorMessageTemplate,
                              Object... errorMessageArgs)
```
    检查状态
    
    Parameters:
    
    condition - 判断状态是否符合条件的结果
    
    errorMessageTemplate - 异常信息模板
    
    errorMessageArgs - 异常信息参数
    
    Throws:
    
    IllegalStateException - 当条件不满足时抛出
  - checkNotNull
```
public static <T> void checkNotNull(T obj)
```
    判空
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    Throws:
    
    NullPointerException - 当 obj 为 null 时抛出
  - checkNotNull
```
public static <T> void checkNotNull(T obj,
                                    String errorMessage)
```
    判空
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    errorMessage - 异常信息
    
    Throws:
    
    NullPointerException - 当 obj 为 null 时抛出
  - checkNotNull
```
public static <T> void checkNotNull(T obj,
                                    Supplier<String> errorMessageSupplier)
```
    判空
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    errorMessageSupplier - 异常信息
    
    Throws:
    
    NullPointerException - 当 obj 为 null 时抛出
  - checkNotNull
```
public static <T> void checkNotNull(T obj,
                                    String errorMessageTemplate,
                                    Object... errorMessageArgs)
```
    判空
    
    Type Parameters:
    
    T - 入参类型
    
    Parameters:
    
    obj - 入参
    
    errorMessageTemplate - 异常信息模板
    
    errorMessageArgs - 异常信息参数
    
    Throws:
    
    NullPointerException - 当 obj 为 null 时抛出
  - checkCondition
```
public static <T extends Exception> void checkCondition(boolean condition,
                                                        Supplier<T> e)
                                                 throws T extends Exception
```
    当条件不满足时抛出异常。
    
    Type Parameters:
    
    T - 异常类型
    
    Parameters:
    
    condition - 条件
    
    e - 异常
    
    Throws:
    
    T - 当条件不满足时抛出异常
    
    T extends Exception

Class AssertTools

Method Summary

Methods inherited from class java.lang.Object

Method Detail

checkArgument

checkArgument

checkArgument

checkArgument

checkArgumentNotNull

checkArgumentNotNull

checkArgumentNotNull

checkArgumentNotNull

checkState

checkState

checkState

checkState

checkNotNull

checkNotNull

checkNotNull

checkNotNull

checkCondition