com.xiaoleilu.hutool.lang

类 Assert

java.lang.Object

com.xiaoleilu.hutool.lang.Assert

public class Assert
extends Object

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

作者:

Looly

构造器概要

构造器

构造器和说明
Assert()

方法概要

方法

限定符和类型	方法和说明
static void	isAssignable(Class<?> superType, Class<?> subType) Assert that superType.isAssignableFrom(subType) is true.
static void	isAssignable(Class<?> superType, Class<?> subType, String message) Assert that superType.isAssignableFrom(subType) is true.
static void	isInstanceOf(Class<?> clazz, Object obj) Assert that the provided object is an instance of the provided class.
static void	isInstanceOf(Class<?> type, Object obj, String message) Assert that the provided object is an instance of the provided class.
static void	isNull(Object object) Assert that an object is null .
static void	isNull(Object object, String message) Assert that an object is null .
static void	isTrue(boolean expression) 断言是否为真，如果为 false 抛出 IllegalArgumentException 异常 Assert.isTrue(i > 0, "The value must be greater than zero");
static void	isTrue(boolean expression, String message) 断言是否为真，如果为 false 抛出 IllegalArgumentException 异常 Assert.isTrue(i > 0, "The value must be greater than zero");
static void	noNullElements(Object[] array) Assert that an array has no null elements.
static void	noNullElements(Object[] array, String message) Assert that an array has no null elements.
static void	notBlank(String text) Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static void	notBlank(String text, String message) Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static void	notContain(String textToSearch, String substring) Assert that the given text does not contain the given substring.
static void	notContain(String textToSearch, String substring, String message) Assert that the given text does not contain the given substring.
static void	notEmpty(Collection<?> collection) Assert that a collection has elements; that is, it must not be null and must have at least one element.
static void	notEmpty(Collection<?> collection, String message) Assert that a collection has elements; that is, it must not be null and must have at least one element.
static void	notEmpty(Map<?,?> map) Assert that a Map has entries; that is, it must not be null and must have at least one entry.
static void	notEmpty(Map<?,?> map, String message) Assert that a Map has entries; that is, it must not be null and must have at least one entry.
static void	notEmpty(Object[] array) Assert that an array has elements; that is, it must not be null and must have at least one element.
static void	notEmpty(Object[] array, String message) Assert that an array has elements; that is, it must not be null and must have at least one element.
static void	notEmpty(String text) Assert that the given String is not empty; that is, it must not be null and not the empty String.
static void	notEmpty(String text, String message) Assert that the given String is not empty; that is, it must not be null and not the empty String.
static void	notNull(Object object) Assert that an object is not null .
static void	notNull(Object object, String message) Assert that an object is not null .
static void	state(boolean expression) Assert a boolean expression, throwing IllegalStateException if the test result is false.
static void	state(boolean expression, String message) Assert a boolean expression, throwing IllegalStateException if the test result is false.

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

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

构造器详细资料

Assert

public Assert()

方法详细资料

isTrue

public static void isTrue(boolean expression,
          String message)

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

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

参数:

expression - 波尔值

message - 错误抛出异常附带的消息

抛出:

IllegalArgumentException - if expression is false

isTrue

public static void isTrue(boolean expression)

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

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

参数:

expression - 波尔值

抛出:

IllegalArgumentException - if expression is false

isNull

public static void isNull(Object object,
          String message)

Assert that an object is null .

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

参数:

object - the object to check

message - the exception message to use if the assertion fails

抛出:

IllegalArgumentException - if the object is not null

isNull

public static void isNull(Object object)

Assert that an object is null .

 Assert.isNull(value);
 

参数:

object - the object to check

抛出:

IllegalArgumentException - if the object is not null

notNull

public static void notNull(Object object,
           String message)

Assert that an object is not null .

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

参数:

object - the object to check

message - the exception message to use if the assertion fails

抛出:

IllegalArgumentException - if the object is null

notNull

public static void notNull(Object object)

Assert that an object is not null .

 Assert.notNull(clazz);
 

参数:

object - the object to check

抛出:

IllegalArgumentException - if the object is null

notEmpty

public static void notEmpty(String text,
            String message)

Assert that the given String is not empty; that is, it must not be null and not the empty String.

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

参数:

text - the String to check

message - the exception message to use if the assertion fails

另请参阅:

StrUtil.isNotEmpty(java.lang.String)

notEmpty

public static void notEmpty(String text)

Assert that the given String is not empty; that is, it must not be null and not the empty String.

 Assert.hasLength(name);
 

参数:

text - the String to check

另请参阅:

StrUtil.isNotEmpty(java.lang.String)

notBlank

public static void notBlank(String text,
            String message)

Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.

 Assert.hasText(name, "'name' must not be empty");
 

参数:

text - the String to check

message - the exception message to use if the assertion fails

另请参阅:

StrUtil.isNotBlank(java.lang.String)

notBlank

public static void notBlank(String text)

Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.

 Assert.hasText(name, "'name' must not be empty");
 

参数:

text - the String to check

另请参阅:

StrUtil.isNotBlank(java.lang.String)

notContain

public static void notContain(String textToSearch,
              String substring,
              String message)

Assert that the given text does not contain the given substring.

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

参数:

textToSearch - the text to search

substring - the substring to find within the text

message - the exception message to use if the assertion fails

notContain

public static void notContain(String textToSearch,
              String substring)

Assert that the given text does not contain the given substring.

 Assert.doesNotContain(name, "rod");
 

参数:

textToSearch - the text to search

substring - the substring to find within the text

notEmpty

public static void notEmpty(Object[] array,
            String message)

Assert that an array has elements; that is, it must not be null and must have at least one element.

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

参数:

array - the array to check

message - the exception message to use if the assertion fails

抛出:

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

notEmpty

public static void notEmpty(Object[] array)

Assert that an array has elements; that is, it must not be null and must have at least one element.

 Assert.notEmpty(array);
 

参数:

array - the array to check

抛出:

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

noNullElements

public static void noNullElements(Object[] array,
                  String message)

Assert that an array has no null elements. Note: Does not complain if the array is empty!

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

参数:

array - the array to check

message - the exception message to use if the assertion fails

抛出:

IllegalArgumentException - if the object array contains a null element

noNullElements

public static void noNullElements(Object[] array)

Assert that an array has no null elements. Note: Does not complain if the array is empty!

 Assert.noNullElements(array);
 

参数:

array - the array to check

抛出:

IllegalArgumentException - if the object array contains a null element

notEmpty

public static void notEmpty(Collection<?> collection,
            String message)

Assert that a collection has elements; that is, it must not be null and must have at least one element.

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

参数:

collection - the collection to check

message - the exception message to use if the assertion fails

抛出:

IllegalArgumentException - if the collection is null or has no elements

notEmpty

public static void notEmpty(Collection<?> collection)

Assert that a collection has elements; that is, it must not be null and must have at least one element.

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

参数:

collection - the collection to check

抛出:

IllegalArgumentException - if the collection is null or has no elements

notEmpty

public static void notEmpty(Map<?,?> map,
            String message)

Assert that a Map has entries; that is, it must not be null and must have at least one entry.

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

参数:

map - the map to check

message - the exception message to use if the assertion fails

抛出:

IllegalArgumentException - if the map is null or has no entries

notEmpty

public static void notEmpty(Map<?,?> map)

Assert that a Map has entries; that is, it must not be null and must have at least one entry.

 Assert.notEmpty(map);
 

参数:

map - the map to check

抛出:

IllegalArgumentException - if the map is null or has no entries

isInstanceOf

public static void isInstanceOf(Class<?> clazz,
                Object obj)

Assert that the provided object is an instance of the provided class.

 Assert.instanceOf(Foo.class, foo);
 

参数:

clazz - the required class

obj - the object to check

抛出:

IllegalArgumentException - if the object is not an instance of clazz

另请参阅:

Class.isInstance(java.lang.Object)

isInstanceOf

public static void isInstanceOf(Class<?> type,
                Object obj,
                String message)

Assert that the provided object is an instance of the provided class.

 Assert.instanceOf(Foo.class, foo);
 

参数:

type - the type to check against

obj - the object to check

message - a message which will be prepended to the message produced by the function itself, and which may be used to provide context. It should normally end in a ": " or ". " so that the function generate message looks ok when prepended to it.

抛出:

IllegalArgumentException - if the object is not an instance of clazz

另请参阅:

Class.isInstance(java.lang.Object)

isAssignable

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

Assert that superType.isAssignableFrom(subType) is true.

 Assert.isAssignable(Number.class, myClass);
 

参数:

superType - the super type to check

subType - the sub type to check

抛出:

IllegalArgumentException - if the classes are not assignable

isAssignable

public static void isAssignable(Class<?> superType,
                Class<?> subType,
                String message)

Assert that superType.isAssignableFrom(subType) is true.

 Assert.isAssignable(Number.class, myClass);
 

参数:

superType - the super type to check against

subType - the sub type to check

message - a message which will be prepended to the message produced by the function itself, and which may be used to provide context. It should normally end in a ": " or ". " so that the function generate message looks ok when prepended to it.

抛出:

IllegalArgumentException - if the classes are not assignable

state

public static void state(boolean expression,
         String message)

Assert a boolean expression, throwing IllegalStateException if the test result is false. Call isTrue if you wish to throw IllegalArgumentException on an assertion failure.

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

参数:

expression - a boolean expression

message - the exception message to use if the assertion fails

抛出:

IllegalStateException - if expression is false

state

public static void state(boolean expression)

Assert a boolean expression, throwing IllegalStateException if the test result is false.

Call isTrue(boolean) if you wish to throw IllegalArgumentException on an assertion failure.

 Assert.state(id == null);
 

参数:

expression - a boolean expression

抛出:

IllegalStateException - if the supplied expression is false