AssertUtil (sofa-common-tools 1.0.17 API)

java.lang.Object
- com.alipay.sofa.common.utils.AssertUtil

public abstract class AssertUtil
extends Object

Created by kevin.luy@alipay.com on 16/9/19.

构造器概要

构造器
构造器和说明

AssertUtil()

构造器
构造器和说明
`AssertUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`hasText(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`	`hasText(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`	`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)` Assert a boolean expression, throwing `IllegalArgumentException` if the test result is `false`.
`static void`	`isTrue(boolean expression, String message)` Assert a boolean expression, throwing `IllegalArgumentException` if the test result is `false`.
`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`	`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`	`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

- 构造器详细资料
  - AssertUtil
```
public AssertUtil()
```
- 方法详细资料
  - isTrue
```
public static void isTrue(boolean expression,
                          String message)
```
    Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
```
Assert.isTrue(i > 0, "The value must be greater than zero");
```
    参数:
    
    expression - a boolean expression
    
    message - the exception message to use if the assertion fails
    
    抛出:
    
    IllegalArgumentException - if expression is false
  - isTrue
```
public static void isTrue(boolean expression)
```
    Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
```
Assert.isTrue(i > 0);
```
    参数:
    
    expression - a boolean 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(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
  - hasText
```
public static void hasText(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
  - hasText
```
public static void hasText(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

类 AssertUtil

构造器概要

方法概要

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

构造器详细资料

AssertUtil

方法详细资料

isTrue

isTrue

isNull

isNull

notNull

notNull

notEmpty

notEmpty

noNullElements

noNullElements

notEmpty

notEmpty

notEmpty

notEmpty

isInstanceOf

isInstanceOf

isAssignable

isAssignable

state

state

hasText

hasText