top.tangyh.basic.utils

类 ArgumentAssert

java.lang.Object

top.tangyh.basic.utils.ArgumentAssert

public class ArgumentAssert
extends Object

断言
断言某些对象或值是否符合规定，否则抛出异常。经常用于做变量检查

作者:

Looly

构造器概要

构造器

构造器和说明
ArgumentAssert()

方法概要

限定符和类型	方法和说明
static double	checkBetween(double value, double min, double max) 检查值是否在指定范围内
static int	checkBetween(int value, int min, int max) 检查值是否在指定范围内
static long	checkBetween(long value, long min, long max) 检查值是否在指定范围内
static Number	checkBetween(Number value, Number min, Number max) 检查值是否在指定范围内
static int	checkIndex(int index, int size) 检查下标（数组、集合、字符串）是否符合要求，下标必须满足： 0 ≤ index < size
static int	checkIndex(int index, int size, String errorMsgTemplate, Object... params) 检查下标（数组、集合、字符串）是否符合要求，下标必须满足： 0 ≤ index < size
static <T> T	contain(Collection<T> collection, T item) 断言给定值是否被另一个集合包含（即是否不为子串） Assert.notContain(names, "张三", "name's 中必须包含 '张三'");
static <T> T	contain(Collection<T> collection, T item, String errorMsgTemplate, Object... params) 断言给定值是否被另一个集合包含（即是否不为子串） Assert.notContain(names, "张三", "name's 中必须包含 '张三'");
static <T,X extends Throwable> T	contain(Collection<T> collection, T item, Supplier<X> errorSupplier) 断言给定值是否被另一个集合包含（即是否不为子串） Assert.notContain(names, "张三", "name's 中必须包含 '张三'");
static void	equals(Object expected, Object actual, String errorMsgTemplate, Object... params) 断言2个字符串是否相等，如果不等用指定错误码抛出异常
static <X extends Throwable> void	equals(Object expected, Object actual, Supplier<? extends X> supplier) 断言2个字符串是否相等，如果 不相等 抛出给定的异常
static void	isAssignable(Class<?> superType, Class<?> subType) 断言 superType.isAssignableFrom(subType) 是否为 true.
static void	isAssignable(Class<?> superType, Class<?> subType, String errorMsgTemplate, Object... params) 断言 superType.isAssignableFrom(subType) 是否为 true.
static void	isFalse(boolean expression) 断言是否为假，如果为 true 抛出 ArgumentException 异常 Assert.isFalse(i < 0);
static void	isFalse(boolean expression, String errorMsgTemplate, Object... params) 断言是否为假，如果为 true 抛出 ArgumentException 异常 Assert.isFalse(i < 0, "The value must be greater than zero");
static <X extends Throwable> void	isFalse(boolean expression, Supplier<X> errorSupplier) 断言是否为假，如果为 true 抛出指定类型异常 并使用指定的函数获取错误信息返回 Assert.isFalse(i > 0, ()->{ // to query relation message return new ArgumentException("relation message to return"); });
static <T> T	isInstanceOf(Class<?> type, T obj) 断言给定对象是否是给定类的实例 Assert.instanceOf(Foo.class, foo);
static <T> T	isInstanceOf(Class<?> type, T obj, String errorMsgTemplate, Object... params) 断言给定对象是否是给定类的实例 Assert.instanceOf(Foo.class, foo);
static void	isNull(Object object) 断言对象是否为null ，如果不为null 抛出ArgumentException 异常 Assert.isNull(value);
static void	isNull(Object object, String errorMsgTemplate, Object... params) 断言对象是否为null ，如果不为null 抛出ArgumentException 异常 Assert.isNull(value, "The value must be null");
static <X extends Throwable> void	isNull(Object object, Supplier<X> errorSupplier) 断言对象是否为null ，如果不为null 抛出指定类型异常 并使用指定的函数获取错误信息返回 Assert.isNull(value, ()->{ // to query relation message return new ArgumentException("relation message to return"); });
static void	isTrue(boolean expression) 断言是否为真，如果为 false 抛出 ArgumentException 异常 Assert.isTrue(i > 0, "The value must be greater than zero");
static void	isTrue(boolean expression, String errorMsgTemplate, Object... params) 断言是否为真，如果为 false 抛出 ArgumentException 异常 Assert.isTrue(i > 0, "The value must be greater than zero");
static <X extends Throwable> void	isTrue(boolean expression, Supplier<? extends X> supplier) 断言是否为真，如果为 false 抛出给定的异常 Assert.isTrue(i > 0, ArgumentException::new);
static <T> T[]	noNullElements(T[] array) 断言给定数组是否不包含null元素，如果数组为空或 null将被认为不包含 Assert.noNullElements(array);
static <T> T[]	noNullElements(T[] array, String errorMsgTemplate, Object... params) 断言给定数组是否不包含null元素，如果数组为空或 null将被认为不包含 Assert.noNullElements(array, "The array must have non-null elements");
static <T,X extends Throwable> T[]	noNullElements(T[] array, Supplier<X> errorSupplier) 断言给定数组是否不包含null元素，如果数组为空或 null将被认为不包含 并使用指定的函数获取错误信息返回 Assert.noNullElements(array, ()->{ // to query relation message return new ArgumentException("relation message to return "); });
static <T extends CharSequence> T	notBlank(T text) 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 ArgumentException Assert.notBlank(name, "Name must not be blank");
static <T extends CharSequence> T	notBlank(T text, String errorMsgTemplate, Object... params) 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 ArgumentException Assert.notBlank(name, "Name must not be blank");
static <T extends CharSequence,X extends Throwable> T	notBlank(T text, Supplier<X> errorMsgSupplier) 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出自定义异常。
static <T extends CharSequence,X extends Throwable> T	notContain(CharSequence textToSearch, T substring, Supplier<X> errorSupplier) 断言给定字符串是否不被另一个字符串包含（即是否为子串） 并使用指定的函数获取错误信息返回 Assert.notContain(name, "rod", ()->{ // to query relation message return new ArgumentException("relation message to return "); });
static <T> T	notContain(Collection<T> collection, T item) 断言给定值是否不被另一个集合包含（即是否为子串） Assert.notContain(names, "张三", "name's 中不能包含 '张三'");
static <T> T	notContain(Collection<T> collection, T item, String errorMsgTemplate, Object... params) 断言给定值是否不被另一个集合包含（即是否为子串） Assert.notContain(names, "张三", "name's 中不能包含 '张三'");
static <T,X extends Throwable> T	notContain(Collection<T> collection, T item, Supplier<X> errorSupplier) 断言给定值是否不被另一个集合包含（即是否为子串） Assert.notContain(names, "张三", "name's 中不能包含 '张三'");
static String	notContain(String textToSearch, String substring) 断言给定字符串是否不被另一个字符串包含（即是否为子串） Assert.notContain(name, "rod", "Name must not contain 'rod'");
static String	notContain(String textToSearch, String substring, String errorMsgTemplate, Object... params) 断言给定字符串是否不被另一个字符串包含（即是否为子串） Assert.notContain(name, "rod", "Name must not contain 'rod'");
static <E,T extends Iterable<E>> T	notEmpty(T collection) 断言给定集合非空 Assert.notEmpty(collection);
static <K,V,T extends Map<K,V>> T	notEmpty(T map) 断言给定Map非空 Assert.notEmpty(map, "Map must have entries");
static <T extends CharSequence> T	notEmpty(T text) 检查给定字符串是否为空，为空抛出 ArgumentException Assert.notEmpty(name);
static <T> T[]	notEmpty(T[] array) 断言给定数组是否包含元素，数组必须不为 null 且至少包含一个元素 Assert.notEmpty(array, "The array must have elements");
static <T> T[]	notEmpty(T[] array, String errorMsgTemplate, Object... params) 断言给定数组是否包含元素，数组必须不为 null 且至少包含一个元素 Assert.notEmpty(array, "The array must have elements");
static <T,X extends Throwable> T[]	notEmpty(T[] array, Supplier<X> errorSupplier) 断言给定数组是否包含元素，数组必须不为 null 且至少包含一个元素 并使用指定的函数获取错误信息返回 Assert.notEmpty(array, ()->{ // to query relation message return new ArgumentException("relation message to return"); });
static <E,T extends Iterable<E>> T	notEmpty(T collection, String errorMsgTemplate, Object... params) 断言给定集合非空 Assert.notEmpty(collection, "Collection must have elements");
static <K,V,T extends Map<K,V>> T	notEmpty(T map, String errorMsgTemplate, Object... params) 断言给定Map非空 Assert.notEmpty(map, "Map must have entries");
static <T extends CharSequence> T	notEmpty(T text, String errorMsgTemplate, Object... params) 检查给定字符串是否为空，为空抛出 ArgumentException Assert.notEmpty(name, "Name must not be empty");
static <E,T extends Iterable<E>,X extends Throwable> T	notEmpty(T collection, Supplier<X> errorSupplier) 断言给定集合非空 并使用指定的函数获取错误信息返回 Assert.notEmpty(collection, ()->{ // to query relation message return new ArgumentException("relation message to return"); });
static <K,V,T extends Map<K,V>,X extends Throwable> T	notEmpty(T map, Supplier<X> errorSupplier) 断言给定Map非空 并使用指定的函数获取错误信息返回 Assert.notEmpty(map, ()->{ // to query relation message return new ArgumentException("relation message to return"); });
static <T extends CharSequence,X extends Throwable> T	notEmpty(T text, Supplier<X> errorSupplier) 检查给定字符串是否为空，为空抛出自定义异常，并使用指定的函数获取错误信息返回。
static <T> T	notNull(T object) 断言对象是否不为null ，如果为null 抛出ArgumentException 异常 Assert.notNull(clazz);
static <T> T	notNull(T object, String errorMsgTemplate, Object... params) 断言对象是否不为null ，如果为null 抛出ArgumentException 异常 Assert that an object is not null .
static <T,X extends Throwable> T	notNull(T object, Supplier<X> errorSupplier) 断言对象是否不为null ，如果为null 抛出指定类型异常 并使用指定的函数获取错误信息返回 Assert.notNull(clazz, ()->{ // to query relation message return new ArgumentException("relation message to return"); });
static void	state(boolean expression) 检查boolean表达式，当检查结果为false时抛出 IllegalStateException。
static void	state(boolean expression, String errorMsgTemplate, Object... params) 检查boolean表达式，当检查结果为false时抛出 IllegalStateException。
static void	state(boolean expression, Supplier<String> errorMsgSupplier) 检查boolean表达式，当检查结果为false时抛出 IllegalStateException。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ArgumentAssert

public ArgumentAssert()

方法详细资料

isTrue

public static <X extends Throwable> void isTrue(boolean expression,
                                                Supplier<? extends X> supplier)
                                         throws X extends Throwable

断言是否为真，如果为 false 抛出给定的异常

 Assert.isTrue(i > 0, ArgumentException::new);
 

类型参数:

X - 异常类型

参数:

expression - 布尔值

supplier - 指定断言不通过时抛出的异常

抛出:

X - if expression is false

X extends Throwable

isTrue

public static void isTrue(boolean expression,
                          String errorMsgTemplate,
                          Object... params)
                   throws ArgumentException

断言是否为真，如果为 false 抛出 ArgumentException 异常

 Assert.isTrue(i > 0, "The value must be greater than zero");
 

参数:

expression - 布尔值

errorMsgTemplate - 错误抛出异常附带的消息模板，变量用{}代替

params - 参数列表

抛出:

ArgumentException - if expression is false

isTrue

public static void isTrue(boolean expression)
                   throws ArgumentException

断言是否为真，如果为 false 抛出 ArgumentException 异常

 Assert.isTrue(i > 0, "The value must be greater than zero");
 

参数:

expression - 布尔值

抛出:

ArgumentException - if expression is false

isFalse

public static <X extends Throwable> void isFalse(boolean expression,
                                                 Supplier<X> errorSupplier)
                                          throws X extends Throwable

断言是否为假，如果为 true 抛出指定类型异常
并使用指定的函数获取错误信息返回

  Assert.isFalse(i > 0, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

X - 异常类型

参数:

expression - 布尔值

errorSupplier - 指定断言不通过时抛出的异常

抛出:

X - if expression is false

X extends Throwable

从以下版本开始:

5.4.5

isFalse

public static void isFalse(boolean expression,
                           String errorMsgTemplate,
                           Object... params)
                    throws ArgumentException

断言是否为假，如果为 true 抛出 ArgumentException 异常

 Assert.isFalse(i < 0, "The value must be greater than zero");
 

参数:

expression - 布尔值

errorMsgTemplate - 错误抛出异常附带的消息模板，变量用{}代替

params - 参数列表

抛出:

ArgumentException - if expression is false

isFalse

public static void isFalse(boolean expression)
                    throws ArgumentException

断言是否为假，如果为 true 抛出 ArgumentException 异常

 Assert.isFalse(i < 0);
 

参数:

expression - 布尔值

抛出:

ArgumentException - if expression is false

isNull

public static <X extends Throwable> void isNull(Object object,
                                                Supplier<X> errorSupplier)
                                         throws X extends Throwable

断言对象是否为null ，如果不为null 抛出指定类型异常 并使用指定的函数获取错误信息返回

 Assert.isNull(value, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

X - 异常类型

参数:

object - 被检查的对象

errorSupplier - 错误抛出异常附带的消息生产接口

抛出:

X - if the object is not null

X extends Throwable

从以下版本开始:

5.4.5

isNull

public static void isNull(Object object,
                          String errorMsgTemplate,
                          Object... params)
                   throws ArgumentException

断言对象是否为null ，如果不为null 抛出ArgumentException 异常

 Assert.isNull(value, "The value must be null");
 

参数:

object - 被检查的对象

errorMsgTemplate - 消息模板，变量使用{}表示

params - 参数列表

抛出:

ArgumentException - if the object is not null

isNull

public static void isNull(Object object)
                   throws ArgumentException

断言对象是否为null ，如果不为null 抛出ArgumentException 异常

 Assert.isNull(value);
 

参数:

object - 被检查对象

抛出:

ArgumentException - if the object is not null

notNull

public static <T,X extends Throwable> T notNull(T object,
                                                Supplier<X> errorSupplier)
                                         throws X extends Throwable

断言对象是否不为null ，如果为null 抛出指定类型异常 并使用指定的函数获取错误信息返回

 Assert.notNull(clazz, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

T - 被检查对象泛型类型

X - 异常类型

参数:

object - 被检查对象

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

被检查后的对象 t

抛出:

X - if the object is null

X extends Throwable

从以下版本开始:

5.4.5

notNull

public static <T> T notNull(T object,
                            String errorMsgTemplate,
                            Object... params)
                     throws ArgumentException

断言对象是否不为null ，如果为null 抛出ArgumentException 异常 Assert that an object is not null .

 Assert.notNull(clazz, "The class must not be null");
 

类型参数:

T - 被检查对象泛型类型

参数:

object - 被检查对象

errorMsgTemplate - 错误消息模板，变量使用{}表示

params - 参数

返回:

被检查后的对象 t

抛出:

ArgumentException - if the object is null

notNull

public static <T> T notNull(T object)
                     throws ArgumentException

断言对象是否不为null ，如果为null 抛出ArgumentException 异常

 Assert.notNull(clazz);
 

类型参数:

T - 被检查对象类型

参数:

object - 被检查对象

返回:

非空对象 t

抛出:

ArgumentException - if the object is null

notEmpty

public static <T extends CharSequence,X extends Throwable> T notEmpty(T text,
                                                                      Supplier<X> errorSupplier)
                                                               throws X extends Throwable

检查给定字符串是否为空，为空抛出自定义异常，并使用指定的函数获取错误信息返回。

 Assert.notEmpty(name, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

T - 字符串类型

X - 异常类型

参数:

text - 被检查字符串

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

非空字符串 t

抛出:

X - 被检查字符串为空抛出此异常

X extends Throwable

从以下版本开始:

5.4.5

另请参阅:

StrUtil#isNotEmpty(CharSequence)

notEmpty

public static <T extends CharSequence> T notEmpty(T text,
                                                  String errorMsgTemplate,
                                                  Object... params)
                                           throws ArgumentException

检查给定字符串是否为空，为空抛出 ArgumentException

 Assert.notEmpty(name, "Name must not be empty");
 

类型参数:

T - 字符串类型

参数:

text - 被检查字符串

errorMsgTemplate - 错误消息模板，变量使用{}表示

params - 参数

返回:

非空字符串 t

抛出:

ArgumentException - 被检查字符串为空

另请参阅:

StrUtil#isNotEmpty(CharSequence)

notEmpty

public static <T extends CharSequence> T notEmpty(T text)
                                           throws ArgumentException

检查给定字符串是否为空，为空抛出 ArgumentException

 Assert.notEmpty(name);
 

类型参数:

T - 字符串类型

参数:

text - 被检查字符串

返回:

被检查的字符串 t

抛出:

ArgumentException - 被检查字符串为空

另请参阅:

StrUtil#isNotEmpty(CharSequence)

notBlank

public static <T extends CharSequence,X extends Throwable> T notBlank(T text,
                                                                      Supplier<X> errorMsgSupplier)
                                                               throws X extends Throwable

检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出自定义异常。 并使用指定的函数获取错误信息返回

 Assert.notBlank(name, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

T - 字符串类型

X - 异常类型

参数:

text - 被检查字符串

errorMsgSupplier - 错误抛出异常附带的消息生产接口

返回:

非空字符串 t

抛出:

X - 被检查字符串为空白

X extends Throwable

另请参阅:

StrUtil#isNotBlank(CharSequence)

notBlank

public static <T extends CharSequence> T notBlank(T text,
                                                  String errorMsgTemplate,
                                                  Object... params)
                                           throws ArgumentException

检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 ArgumentException

 Assert.notBlank(name, "Name must not be blank");
 

类型参数:

T - 字符串类型

参数:

text - 被检查字符串

errorMsgTemplate - 错误消息模板，变量使用{}表示

params - 参数

返回:

非空字符串 t

抛出:

ArgumentException - 被检查字符串为空白

另请参阅:

StrUtil#isNotBlank(CharSequence)

notBlank

public static <T extends CharSequence> T notBlank(T text)
                                           throws ArgumentException

检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 ArgumentException

 Assert.notBlank(name, "Name must not be blank");
 

类型参数:

T - 字符串类型

参数:

text - 被检查字符串

返回:

非空字符串 t

抛出:

ArgumentException - 被检查字符串为空白

另请参阅:

StrUtil#isNotBlank(CharSequence)

notContain

public static <T extends CharSequence,X extends Throwable> T notContain(CharSequence textToSearch,
                                                                        T substring,
                                                                        Supplier<X> errorSupplier)
                                                                 throws X extends Throwable

断言给定字符串是否不被另一个字符串包含（即是否为子串） 并使用指定的函数获取错误信息返回

 Assert.notContain(name, "rod", ()->{
      // to query relation message
      return new ArgumentException("relation message to return ");
  });
 

类型参数:

T - 字符串类型

X - 异常类型

参数:

textToSearch - 被搜索的字符串

substring - 被检查的子串

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

被检查的子串 t

抛出:

X - 非子串抛出异常

X extends Throwable

从以下版本开始:

5.4.5

另请参阅:

StrUtil#contains(CharSequence, CharSequence)

notContain

public static String notContain(String textToSearch,
                                String substring,
                                String errorMsgTemplate,
                                Object... params)
                         throws ArgumentException

断言给定字符串是否不被另一个字符串包含（即是否为子串）

 Assert.notContain(name, "rod", "Name must not contain 'rod'");
 

参数:

textToSearch - 被搜索的字符串

substring - 被检查的子串

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查的子串 string

抛出:

ArgumentException - 非子串抛出异常

notContain

public static String notContain(String textToSearch,
                                String substring)
                         throws ArgumentException

断言给定字符串是否不被另一个字符串包含（即是否为子串）

 Assert.notContain(name, "rod", "Name must not contain 'rod'");
 

参数:

textToSearch - 被搜索的字符串

substring - 被检查的子串

返回:

被检查的子串 string

抛出:

ArgumentException - 非子串抛出异常

contain

public static <T> T contain(Collection<T> collection,
                            T item)
                     throws ArgumentException

断言给定值是否被另一个集合包含（即是否不为子串）

 Assert.notContain(names, "张三", "name's 中必须包含 '张三'");
 

参数:

collection - 被搜索的集合

item - 被检查的值

返回:

被检查的值 string

抛出:

ArgumentException - 非子串抛出异常

contain

public static <T> T contain(Collection<T> collection,
                            T item,
                            String errorMsgTemplate,
                            Object... params)
                     throws ArgumentException

断言给定值是否被另一个集合包含（即是否不为子串）

 Assert.notContain(names, "张三", "name's 中必须包含 '张三'");
 

参数:

collection - 被搜索的集合

item - 被检查的值

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查的值 string

抛出:

ArgumentException - 非子串抛出异常

contain

public static <T,X extends Throwable> T contain(Collection<T> collection,
                                                T item,
                                                Supplier<X> errorSupplier)
                                         throws X extends Throwable

断言给定值是否被另一个集合包含（即是否不为子串）

 Assert.notContain(names, "张三", "name's 中必须包含 '张三'");
 

参数:

collection - 被搜索的集合

item - 被检查的值

返回:

被检查的值 string

抛出:

ArgumentException - 非子串抛出异常

X extends Throwable

notContain

public static <T> T notContain(Collection<T> collection,
                               T item)
                        throws ArgumentException

断言给定值是否不被另一个集合包含（即是否为子串）

 Assert.notContain(names, "张三", "name's 中不能包含 '张三'");
 

参数:

collection - 被搜索的集合

item - 被检查的值

返回:

被检查的值 string

抛出:

ArgumentException - 非子串抛出异常

notContain

public static <T> T notContain(Collection<T> collection,
                               T item,
                               String errorMsgTemplate,
                               Object... params)
                        throws ArgumentException

断言给定值是否不被另一个集合包含（即是否为子串）

 Assert.notContain(names, "张三", "name's 中不能包含 '张三'");
 

参数:

collection - 被搜索的集合

item - 被检查的值

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查的值 string

抛出:

ArgumentException - 非子串抛出异常

notContain

public static <T,X extends Throwable> T notContain(Collection<T> collection,
                                                   T item,
                                                   Supplier<X> errorSupplier)
                                            throws X extends Throwable

断言给定值是否不被另一个集合包含（即是否为子串）

 Assert.notContain(names, "张三", "name's 中不能包含 '张三'");
 

参数:

collection - 被搜索的集合

item - 被检查的值

返回:

被检查的值 string

抛出:

ArgumentException - 非子串抛出异常

X extends Throwable

notEmpty

public static <T,X extends Throwable> T[] notEmpty(T[] array,
                                                   Supplier<X> errorSupplier)
                                            throws X extends Throwable

断言给定数组是否包含元素，数组必须不为 null 且至少包含一个元素 并使用指定的函数获取错误信息返回

 Assert.notEmpty(array, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

T - 数组元素类型

X - 异常类型

参数:

array - 被检查的数组

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

被检查的数组 t [ ]

抛出:

X - if the object array is null or has no elements

X extends Throwable

从以下版本开始:

5.4.5

另请参阅:

ArrayUtil#isNotEmpty(Object[])

notEmpty

public static <T> T[] notEmpty(T[] array,
                               String errorMsgTemplate,
                               Object... params)
                        throws ArgumentException

断言给定数组是否包含元素，数组必须不为 null 且至少包含一个元素

 Assert.notEmpty(array, "The array must have elements");
 

类型参数:

T - 数组元素类型

参数:

array - 被检查的数组

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查的数组 t [ ]

抛出:

ArgumentException - if the object array is null or has no elements

notEmpty

public static <T> T[] notEmpty(T[] array)
                        throws ArgumentException

断言给定数组是否包含元素，数组必须不为 null 且至少包含一个元素

 Assert.notEmpty(array, "The array must have elements");
 

类型参数:

T - 数组元素类型

参数:

array - 被检查的数组

返回:

被检查的数组 t [ ]

抛出:

ArgumentException - if the object array is null or has no elements

noNullElements

public static <T,X extends Throwable> T[] noNullElements(T[] array,
                                                         Supplier<X> errorSupplier)
                                                  throws X extends Throwable

断言给定数组是否不包含null元素，如果数组为空或 null将被认为不包含 并使用指定的函数获取错误信息返回

 Assert.noNullElements(array, ()->{
      // to query relation message
      return new ArgumentException("relation message to return ");
  });
 

类型参数:

T - 数组元素类型

X - 异常类型

参数:

array - 被检查的数组

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

被检查的数组 t [ ]

抛出:

X - if the object array contains a null element

X extends Throwable

从以下版本开始:

5.4.5

另请参阅:

ArrayUtil#hasNull(Object[])

noNullElements

public static <T> T[] noNullElements(T[] array,
                                     String errorMsgTemplate,
                                     Object... params)
                              throws ArgumentException

断言给定数组是否不包含null元素，如果数组为空或 null将被认为不包含

 Assert.noNullElements(array, "The array must have non-null elements");
 

类型参数:

T - 数组元素类型

参数:

array - 被检查的数组

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查的数组 t [ ]

抛出:

ArgumentException - if the object array contains a null element

noNullElements

public static <T> T[] noNullElements(T[] array)
                              throws ArgumentException

断言给定数组是否不包含null元素，如果数组为空或 null将被认为不包含

 Assert.noNullElements(array);
 

类型参数:

T - 数组元素类型

参数:

array - 被检查的数组

返回:

被检查的数组 t [ ]

抛出:

ArgumentException - if the object array contains a null element

notEmpty

public static <E,T extends Iterable<E>,X extends Throwable> T notEmpty(T collection,
                                                                       Supplier<X> errorSupplier)
                                                                throws X extends Throwable

断言给定集合非空 并使用指定的函数获取错误信息返回

 Assert.notEmpty(collection, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

E - 集合元素类型

T - 集合类型

X - 异常类型

参数:

collection - 被检查的集合

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

非空集合 t

抛出:

X - if the collection is null or has no elements

X extends Throwable

从以下版本开始:

5.4.5

另请参阅:

CollUtil#isNotEmpty(Iterable)

notEmpty

public static <E,T extends Iterable<E>> T notEmpty(T collection,
                                                   String errorMsgTemplate,
                                                   Object... params)
                                            throws ArgumentException

断言给定集合非空

 Assert.notEmpty(collection, "Collection must have elements");
 

类型参数:

E - 集合元素类型

T - 集合类型

参数:

collection - 被检查的集合

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

非空集合 t

抛出:

ArgumentException - if the collection is null or has no elements

notEmpty

public static <E,T extends Iterable<E>> T notEmpty(T collection)
                                            throws ArgumentException

断言给定集合非空

 Assert.notEmpty(collection);
 

类型参数:

E - 集合元素类型

T - 集合类型

参数:

collection - 被检查的集合

返回:

被检查集合 t

抛出:

ArgumentException - if the collection is null or has no elements

notEmpty

public static <K,V,T extends Map<K,V>,X extends Throwable> T notEmpty(T map,
                                                                      Supplier<X> errorSupplier)
                                                               throws X extends Throwable

断言给定Map非空 并使用指定的函数获取错误信息返回

 Assert.notEmpty(map, ()->{
      // to query relation message
      return new ArgumentException("relation message to return");
  });
 

类型参数:

K - Key类型

V - Value类型

T - Map类型

X - 异常类型

参数:

map - 被检查的Map

errorSupplier - 错误抛出异常附带的消息生产接口

返回:

被检查的Map t

抛出:

X - if the map is null or has no entries

X extends Throwable

从以下版本开始:

5.4.5

另请参阅:

MapUtil#isNotEmpty(Map)

notEmpty

public static <K,V,T extends Map<K,V>> T notEmpty(T map,
                                                  String errorMsgTemplate,
                                                  Object... params)
                                           throws ArgumentException

断言给定Map非空

 Assert.notEmpty(map, "Map must have entries");
 

类型参数:

K - Key类型

V - Value类型

T - Map类型

参数:

map - 被检查的Map

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查的Map t

抛出:

ArgumentException - if the map is null or has no entries

notEmpty

public static <K,V,T extends Map<K,V>> T notEmpty(T map)
                                           throws ArgumentException

断言给定Map非空

 Assert.notEmpty(map, "Map must have entries");
 

类型参数:

K - Key类型

V - Value类型

T - Map类型

参数:

map - 被检查的Map

返回:

被检查的Map t

抛出:

ArgumentException - if the map is null or has no entries

isInstanceOf

public static <T> T isInstanceOf(Class<?> type,
                                 T obj)

断言给定对象是否是给定类的实例

 Assert.instanceOf(Foo.class, foo);
 

类型参数:

T - 被检查对象泛型类型

参数:

type - 被检查对象匹配的类型

obj - 被检查对象

返回:

被检查的对象 t

抛出:

ArgumentException - if the object is not an instance of clazz

另请参阅:

Class#isInstance(Object)

isInstanceOf

public static <T> T isInstanceOf(Class<?> type,
                                 T obj,
                                 String errorMsgTemplate,
                                 Object... params)
                          throws ArgumentException

断言给定对象是否是给定类的实例

 Assert.instanceOf(Foo.class, foo);
 

类型参数:

T - 被检查对象泛型类型

参数:

type - 被检查对象匹配的类型

obj - 被检查对象

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

被检查对象 t

抛出:

ArgumentException - if the object is not an instance of clazz

另请参阅:

Class#isInstance(Object)

isAssignable

public static void isAssignable(Class<?> superType,
                                Class<?> subType)
                         throws ArgumentException

断言 superType.isAssignableFrom(subType) 是否为 true.

 Assert.isAssignable(Number.class, myClass);
 

参数:

superType - 需要检查的父类或接口

subType - 需要检查的子类

抛出:

ArgumentException - 如果子类非继承父类，抛出此异常

isAssignable

public static void isAssignable(Class<?> superType,
                                Class<?> subType,
                                String errorMsgTemplate,
                                Object... params)
                         throws ArgumentException

断言 superType.isAssignableFrom(subType) 是否为 true.

 Assert.isAssignable(Number.class, myClass);
 

参数:

superType - 需要检查的父类或接口

subType - 需要检查的子类

errorMsgTemplate - 异常时的消息模板

params - 参数列表

抛出:

ArgumentException - 如果子类非继承父类，抛出此异常

state

public static void state(boolean expression,
                         Supplier<String> errorMsgSupplier)
                  throws IllegalStateException

检查boolean表达式，当检查结果为false时抛出 IllegalStateException。 并使用指定的函数获取错误信息返回

 Assert.state(id == null, ()->{
      // to query relation message
      return "relation message to return ";
  });
 

参数:

expression - boolean 表达式

errorMsgSupplier - 错误抛出异常附带的消息生产接口

抛出:

IllegalStateException - 表达式为 false 抛出此异常

state

public static void state(boolean expression,
                         String errorMsgTemplate,
                         Object... params)
                  throws IllegalStateException

检查boolean表达式，当检查结果为false时抛出 IllegalStateException。

 Assert.state(id == null, "The id property must not already be initialized");
 

参数:

expression - boolean 表达式

errorMsgTemplate - 异常时的消息模板

params - 参数列表

抛出:

IllegalStateException - 表达式为 false 抛出此异常

state

public static void state(boolean expression)
                  throws IllegalStateException

检查boolean表达式，当检查结果为false时抛出 IllegalStateException。

 Assert.state(id == null);
 

参数:

expression - boolean 表达式

抛出:

IllegalStateException - 表达式为 false 抛出此异常

checkIndex

public static int checkIndex(int index,
                             int size)
                      throws ArgumentException,
                             IndexOutOfBoundsException

检查下标（数组、集合、字符串）是否符合要求，下标必须满足：

 0 ≤ index < size
 

参数:

index - 下标

size - 长度

返回:

检查后的下标 int

抛出:

ArgumentException - 如果size < 0 抛出此异常

IndexOutOfBoundsException - 如果index < 0或者 index ≥ size 抛出此异常

从以下版本开始:

4.1.9

checkIndex

public static int checkIndex(int index,
                             int size,
                             String errorMsgTemplate,
                             Object... params)
                      throws ArgumentException,
                             IndexOutOfBoundsException

检查下标（数组、集合、字符串）是否符合要求，下标必须满足：

 0 ≤ index < size
 

参数:

index - 下标

size - 长度

errorMsgTemplate - 异常时的消息模板

params - 参数列表

返回:

检查后的下标 int

抛出:

ArgumentException - 如果size < 0 抛出此异常

IndexOutOfBoundsException - 如果index < 0或者 index ≥ size 抛出此异常

从以下版本开始:

4.1.9

checkBetween

public static int checkBetween(int value,
                               int min,
                               int max)

检查值是否在指定范围内

参数:

value - 值

min - 最小值（包含）

max - 最大值（包含）

返回:

检查后的长度值 int

从以下版本开始:

4.1.10

checkBetween

public static long checkBetween(long value,
                                long min,
                                long max)

检查值是否在指定范围内

参数:

value - 值

min - 最小值（包含）

max - 最大值（包含）

返回:

检查后的长度值 long

从以下版本开始:

4.1.10

checkBetween

public static double checkBetween(double value,
                                  double min,
                                  double max)

检查值是否在指定范围内

参数:

value - 值

min - 最小值（包含）

max - 最大值（包含）

返回:

检查后的长度值 double

从以下版本开始:

4.1.10

checkBetween

public static Number checkBetween(Number value,
                                  Number min,
                                  Number max)

检查值是否在指定范围内

参数:

value - 值

min - 最小值（包含）

max - 最大值（包含）

返回:

检查后的长度值 number

从以下版本开始:

4.1.10

equals

public static void equals(Object expected,
                          Object actual,
                          String errorMsgTemplate,
                          Object... params)

断言2个字符串是否相等，如果不等用指定错误码抛出异常

参数:

expected - 预期的值

actual - 需要比较的字符串expected

errorMsgTemplate - 错误抛出异常附带的消息模板，变量用{}代替

params - 参数列表

抛出:

ArgumentException - if expression is false

equals

public static <X extends Throwable> void equals(Object expected,
                                                Object actual,
                                                Supplier<? extends X> supplier)
                                         throws X extends Throwable

断言2个字符串是否相等，如果 不相等 抛出给定的异常

参数:

expected - 预期的值

actual - 需要比较的字符串

supplier - 指定断言不通过时抛出的异常

抛出:

X - if expression is false

X extends Throwable