Assert (admin4j-common 0.1.1 API)

All Known Implementing Classes:

ResponseEnum
```
public interface Assert
```
Since:

2023/3/21 13:52

Author:

andanyang

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`equals(Object o1, Object o2, String errMsg)` 断言对象`o1`与对象`o2`相等，此处的相等指（o1.equals(o2)为true）。如果两对象不相等，则抛出异常
`default void`	`equals(Object o1, Object o2, String errMsg, Object... args)` 断言对象`o1`与对象`o2`相等，此处的相等指（o1.equals(o2)为true）。如果两对象不相等，则抛出异常
`default void`	`fail(String errMsg)` 直接抛出异常
`default void`	`fail(String errMsg, Throwable t)` 直接抛出异常，并包含原异常信息
`default void`	`fail(String errMsg, Throwable t, Object... args)` 直接抛出异常，并包含原异常信息
`default void`	`fail(Throwable t)` 直接抛出异常，并包含原异常信息
`default void`	`isFalse(boolean expression, String errMsg)` 断言布尔值`expression`为false。如果布尔值`expression`为true，则抛出异常
`default void`	`isFalse(boolean expression, String errMsg, Object... args)` 断言布尔值`expression`为false。如果布尔值`expression`为true，则抛出异常
`default void`	`isNull(Object obj, String errMsg)` 断言对象`obj`为`null`。如果对象`obj`不为`null`，则抛出异常
`default void`	`isNull(Object obj, String errMsg, Object... args)` 断言对象`obj`为`null`。如果对象`obj`不为`null`，则抛出异常
`default void`	`isTrue(boolean expression, String errMsg)` 断言布尔值`expression`为true。如果布尔值`expression`为false，则抛出异常
`default void`	`isTrue(boolean expression, String errMsg, Object... args)` 断言布尔值`expression`为true。如果布尔值`expression`为false，则抛出异常
`Admin4jException`	`newException(String errMsg)`
`default Admin4jException`	`newException(String errMsg, Object... args)` 创建异常
`Admin4jException`	`newException(Throwable t)`
`Admin4jException`	`newException(Throwable t, String errMsg)` 创建异常
`default Admin4jException`	`newException(Throwable t, String errMsg, Object... args)` 创建异常.
`default void`	`notEmpty(Collection<?> c, String errMsg)` 断言集合`c`大小不为0。如果集合`c`大小不为0，则抛出异常
`default void`	`notEmpty(Collection<?> c, String errMsg, Object... args)` 断言集合`c`大小不为0。如果集合`c`大小不为0，则抛出异常
`default void`	`notEmpty(Map<?,?> map, String errMsg)` 断言Map`map`大小不为0。如果Map`map`大小不为0，则抛出异常
`default void`	`notEmpty(Map<?,?> map, String errMsg, Object... args)` 断言Map`map`大小不为0。如果Map`map`大小不为0，则抛出异常
`default void`	`notEmpty(Object[] arrays, String errMsg)` 断言数组`arrays`大小不为0。如果数组`arrays`大小不为0，则抛出异常
`default void`	`notEmpty(Object[] arrays, String errMsg, Object... args)` 断言数组`arrays`大小不为0。如果数组`arrays`大小不为0，则抛出异常
`default void`	`notEmpty(String str, String errMsg)` 断言字符串`str`不为空串（长度为0）。如果字符串`str`为空串，则抛出异常
`default void`	`notEmpty(String str, String errMsg, Object... args)` 断言字符串`str`不为空串（长度为0）。如果字符串`str`为空串，则抛出异常
`default void`	`notNull(Object obj, String errMsg)` 断言对象`obj`非空。如果对象`obj`为空，则抛出异常
`default void`	`notNull(Object obj, String errMsg, Object... args)` 断言对象`obj`非空。如果对象`obj`为空，则抛出异常
`default void`	`notNull(Object obj, java.util.function.Supplier<String> errMsg, Object... args)` 断言对象`obj`非空。如果对象`obj`为空，则抛出异常

- Method Detail
  - newException
```
Admin4jException newException(Throwable t,
                              String errMsg)
```
    创建异常
    
    Parameters:
    
    t - 异常
    
    errMsg - msg
    
    Returns:
  - newException
```
Admin4jException newException(Throwable t)
```
  - newException
```
Admin4jException newException(String errMsg)
```
  - newException
```
default Admin4jException newException(String errMsg,
                                      Object... args)
```
    创建异常
    
    Parameters:
    
    errMsg - 异常msg
    
    Returns:
  - newException
```
default Admin4jException newException(Throwable t,
                                      String errMsg,
                                      Object... args)
```
    创建异常. 先使用 errMsg 创建一个 WrapMessageException 异常, 再以入参的形式传给 newException(Throwable, String), 作为最后创建的异常的 cause 属性.
    
    Parameters:
    
    errMsg - 自定义的错误信息
    
    args -
    
    Returns:
  - notNull
```
default void notNull(Object obj,
                     String errMsg)
```
    断言对象obj非空。如果对象obj为空，则抛出异常
    
    Parameters:
    
    obj - 待判断对象
    
    errMsg - 自定义的错误信息
  - notNull
```
default void notNull(Object obj,
                     String errMsg,
                     Object... args)
```
    断言对象obj非空。如果对象obj为空，则抛出异常
    异常信息message支持传递参数方式，避免在判断之前进行字符串拼接操作
    
    Parameters:
    
    obj - 待判断对象
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - notNull
```
default void notNull(Object obj,
                     java.util.function.Supplier<String> errMsg,
                     Object... args)
```
    断言对象obj非空。如果对象obj为空，则抛出异常
    异常信息message支持传递参数方式，避免在判断之前进行字符串拼接操作
    
    Parameters:
    
    obj - 待判断对象
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - notEmpty
```
default void notEmpty(String str,
                      String errMsg)
```
    断言字符串str不为空串（长度为0）。如果字符串str为空串，则抛出异常
    
    Parameters:
    
    str - 待判断字符串
    
    errMsg - 自定义的错误信息
  - notEmpty
```
default void notEmpty(String str,
                      String errMsg,
                      Object... args)
```
    断言字符串str不为空串（长度为0）。如果字符串str为空串，则抛出异常
    异常信息message支持传递参数方式，避免在判断之前进行字符串拼接操作
    
    Parameters:
    
    str - 待判断字符串
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - notEmpty
```
default void notEmpty(Object[] arrays,
                      String errMsg)
```
    断言数组arrays大小不为0。如果数组arrays大小不为0，则抛出异常
    
    Parameters:
    
    arrays - 待判断数组
    
    errMsg - 自定义的错误信息
  - notEmpty
```
default void notEmpty(Object[] arrays,
                      String errMsg,
                      Object... args)
```
    断言数组arrays大小不为0。如果数组arrays大小不为0，则抛出异常
    异常信息message支持传递参数方式，避免在判断之前进行字符串拼接操作
    
    Parameters:
    
    arrays - 待判断数组
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - notEmpty
```
default void notEmpty(Collection<?> c,
                      String errMsg)
```
    断言集合c大小不为0。如果集合c大小不为0，则抛出异常
    
    Parameters:
    
    c - 待判断数组
    
    errMsg - 自定义的错误信息
  - notEmpty
```
default void notEmpty(Collection<?> c,
                      String errMsg,
                      Object... args)
```
    断言集合c大小不为0。如果集合c大小不为0，则抛出异常
    
    Parameters:
    
    c - 待判断数组
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - notEmpty
```
default void notEmpty(Map<?,?> map,
                      String errMsg)
```
    断言Mapmap大小不为0。如果Mapmap大小不为0，则抛出异常
    
    Parameters:
    
    map - 待判断Map
    
    errMsg - 自定义的错误信息
  - notEmpty
```
default void notEmpty(Map<?,?> map,
                      String errMsg,
                      Object... args)
```
    断言Mapmap大小不为0。如果Mapmap大小不为0，则抛出异常
    
    Parameters:
    
    map - 待判断Map
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - isFalse
```
default void isFalse(boolean expression,
                     String errMsg)
```
    断言布尔值expression为false。如果布尔值expression为true，则抛出异常
    
    Parameters:
    
    expression - 待判断布尔变量
    
    errMsg - 自定义的错误信息
  - isFalse
```
default void isFalse(boolean expression,
                     String errMsg,
                     Object... args)
```
    断言布尔值expression为false。如果布尔值expression为true，则抛出异常
    
    Parameters:
    
    expression - 待判断布尔变量
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - isTrue
```
default void isTrue(boolean expression,
                    String errMsg)
```
    断言布尔值expression为true。如果布尔值expression为false，则抛出异常
    
    Parameters:
    
    expression - 待判断布尔变量
    
    errMsg - 自定义的错误信息
  - isTrue
```
default void isTrue(boolean expression,
                    String errMsg,
                    Object... args)
```
    断言布尔值expression为true。如果布尔值expression为false，则抛出异常
    
    Parameters:
    
    expression - 待判断布尔变量
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - isNull
```
default void isNull(Object obj,
                    String errMsg)
```
    断言对象obj为null。如果对象obj不为null，则抛出异常
    
    Parameters:
    
    obj - 待判断对象
    
    errMsg - 自定义的错误信息
  - isNull
```
default void isNull(Object obj,
                    String errMsg,
                    Object... args)
```
    断言对象obj为null。如果对象obj不为null，则抛出异常
    
    Parameters:
    
    obj - 待判断布尔变量
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - equals
```
default void equals(Object o1,
                    Object o2,
                    String errMsg)
```
    断言对象o1与对象o2相等，此处的相等指（o1.equals(o2)为true）。如果两对象不相等，则抛出异常
    
    Parameters:
    
    o1 - 待判断对象，若o1为null，也当作不相等处理
    
    o2 - 待判断对象
    
    errMsg - 自定义的错误信息
  - equals
```
default void equals(Object o1,
                    Object o2,
                    String errMsg,
                    Object... args)
```
    断言对象o1与对象o2相等，此处的相等指（o1.equals(o2)为true）。如果两对象不相等，则抛出异常
    
    Parameters:
    
    o1 - 待判断对象，若o1为null，也当作不相等处理
    
    o2 - 待判断对象
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    args - message占位符对应的参数列表
  - fail
```
default void fail(Throwable t)
```
    直接抛出异常，并包含原异常信息
    当捕获非运行时异常（非继承RuntimeException）时，并该异常进行业务描述时，必须传递原始异常，作为新异常的cause
    
    Parameters:
    
    t - 原始异常
  - fail
```
default void fail(String errMsg)
```
    直接抛出异常
    
    Parameters:
    
    errMsg - 自定义的错误信息
  - fail
```
default void fail(String errMsg,
                  Throwable t)
```
    直接抛出异常，并包含原异常信息
    当捕获非运行时异常（非继承RuntimeException）时，并该异常进行业务描述时，必须传递原始异常，作为新异常的cause
    
    Parameters:
    
    errMsg - 自定义的错误信息
    
    t - 原始异常
  - fail
```
default void fail(String errMsg,
                  Throwable t,
                  Object... args)
```
    直接抛出异常，并包含原异常信息
    当捕获非运行时异常（非继承RuntimeException）时，并该异常进行业务描述时，必须传递原始异常，作为新异常的cause
    
    Parameters:
    
    errMsg - 自定义的错误信息. 支持 {index} 形式的占位符, 比如: errMsg-用户[{0}]不存在, args-1001, 最后打印-用户[1001]不存在
    
    t - 原始异常
    
    args - message占位符对应的参数列表

Interface Assert

Method Summary

Method Detail

newException

newException

newException

newException

newException

notNull

notNull

notNull

notEmpty

notEmpty

notEmpty

notEmpty

notEmpty

notEmpty

notEmpty

notEmpty

isFalse

isFalse

isTrue

isTrue

isNull

isNull

equals

equals

fail

fail

fail

fail