/**
* 一个通用的断言类，主要用于参数检查等。通过采用Assert类，可以省去写很多try...catch...语句的麻烦，
* 使得代码更加简单清晰，同时可以提高单元测试分支覆盖率。
*/
package org.dayatang.utils;
import org.apache.commons.lang3.StringUtils;
import java.util.Collection;
import java.util.Map;
/**
* @author chencao
*
* 2011-5-25
*/
@SuppressWarnings("rawtypes")
public class Assert {
//私有构造函数，防止客户代码实例化Assert。
private Assert() {
}
/**
* 断言表达式{@code expression}的值为真。如果表达式的值为假则抛出
* <code>IllegalArgumentException</code>异常。
*
* <pre class="code">
* Assert.isTrue(i > 0, "The value must be greater than zero");
* </pre>
*
* @param expression 一个布尔表达式
* @param message 断言失败时呈现的异常消息
* @throws IllegalArgumentException 如果表达式的值是<code>false</code>
*/
public static void isTrue(boolean expression, String message) {
if (!expression) {
throw new IllegalArgumentException(message);
}
}
/**
* 断言表达式{@code expression}的值为真。如果表达式的值为假则抛出
* <code>IllegalArgumentException</code>异常。
*
* <pre class="code">
* Assert.isTrue(i > 0);
* </pre>
*
* @param expression 一个布尔表达式
* @throws IllegalArgumentException 如果表达式的值是<code>false</code>
*/
public static void isTrue(boolean expression) {
isTrue(expression, "[Assertion failed] - this expression must be true");
}
/**
* 断言表达式{@code expression}的值为假。如果表达式的值为真则抛出
* <code>IllegalArgumentException</code>异常。
*
* <pre class="code">
* Assert.isFalse(i > 0, "The value must be smaller than zero");
* </pre>
*
* @param expression 一个布尔表达式
* @param message 断言失败时呈现的异常消息
* @throws IllegalArgumentException 如果表达式的值是<code>true</code>
*/
public static void isFalse(boolean expression, String message) {
if (expression) {
throw new IllegalArgumentException(message);
}
}
/**
* 断言表达式{@code expression}的值为假。如果表达式的值为真则抛出
* <code>IllegalArgumentException</code>异常。
*
* <pre class="code">
* Assert.isFalse(i > 0);
* </pre>
*
* @param expression 一个布尔表达式
* @throws IllegalArgumentException 如果表达式的值是<code>true</code>
*/
public static void isFalse(boolean expression) {
isFalse(expression, "[Assertion failed] - this expression must be false");
}
/**
* Assert that an object is <code>null</code> .
*
* <pre class="code">
* Assert.isNull(value, "The value must be null");
* </pre>
*
* @param object the object to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object is not <code>null</code>
*/
public static void isNull(Object object, String message) {
if (object != null) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that an object is <code>null</code> .
*
* <pre class="code">
* Assert.isNull(value);
* </pre>
*
* @param object the object to check
* @throws IllegalArgumentException if the object is not <code>null</code>
*/
public static void isNull(Object object) {
isNull(object, "[Assertion failed] - the object argument must be null");
}
/**
* Assert that an object is not <code>null</code> .
*
* <pre class="code">
* Assert.notNull(clazz, "The class must not be null");
* </pre>
*
* @param object the object to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object is <code>null</code>
*/
public static void notNull(Object object, String message) {
if (object == null) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that an object is not <code>null</code> .
*
* <pre class="code">
* Assert.notNull(clazz);
* </pre>
*
* @param object the object to check
* @throws IllegalArgumentException if the object is <code>null</code>
*/
public static void notNull(Object object) {
notNull(object,
"[Assertion failed] - this argument is required; it must not be null");
}
/**
* Assert that a character sequence is null or contains no character
*
* @param text the character sequence to be checked
* @param message the exception message to display when the assertion failed
*/
public static void isEmpty(CharSequence text, String message) {
if (StringUtils.isNotEmpty(text)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that a character sequence is null or contains no character
*
* @param text the character sequence to be checked
*/
public static void isEmpty(CharSequence text) {
isEmpty(text, "[Assertion failed] - this CharSequence argument must contains one character at least");
}
/**
* Assert that a character sequence contains one character at least.
*
* @param text the character sequence to be checked
* @param message the exception message to display when the assertion failed
*/
public static void notEmpty(CharSequence text, String message) {
if (StringUtils.isEmpty(text)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that a character sequence contains one character at least.
*
* @param text the character sequence to be checked
*/
public static void notEmpty(CharSequence text) {
notEmpty(text, "[Assertion failed] - this CharSequence argument must contains one character at least");
}
/**
* Assert that an array is <code>null</code> or has not elements.
*
* <pre class="code">
* Assert.isEmpty(array, "The array must have not elements");
* </pre>
*
* @param array the array to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object array has any elements
*/
public static void isEmpty(Object[] array, String message) {
if (array != null && array.length > 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that an array is <code>null</code> or has not elements.
*
* <pre class="code">
* Assert.isEmpty(array, "The array must have not elements");
* </pre>
*
* @param array the array to check
* @throws IllegalArgumentException if the object array has any elements
*/
public static void isEmpty(Object[] array) {
isEmpty(array, "[Assertion failed] - this array must be empty: it must not contain any element");
}
/**
* Assert that an array has at least one element.
*
* <pre class="code">
* Assert.notEmpty(array, "The array must have elements");
* </pre>
*
* @param array the array to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object array is <code>null</code>
* or has no elements
*/
public static void notEmpty(Object[] array, String message) {
if (array == null || array.length == 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that an array has at least one element.
*
* <pre class="code">
* Assert.notEmpty(array);
* </pre>
*
* @param array the array to check
* @throws IllegalArgumentException if the object array is <code>null</code>
* or has no elements
*/
public static void notEmpty(Object[] array) {
notEmpty(array, "[Assertion failed] - this array must not be empty: it must contain at least 1 element");
}
/**
* Assert that a collection has no elements.
*
* <pre class="code">
* Assert.isEmpty(collection, "Collection must have elements");
* </pre>
*
* @param collection the collection to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the collection has any elements
*/
public static void isEmpty(Collection collection, String message) {
if (collection != null && collection.size() > 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that a collection has no elements.
*
* <pre class="code">
* Assert.notEmpty(collection, "Collection must have elements");
* </pre>
*
* @param collection the collection to check
* @throws IllegalArgumentException if the collection has any elements
*/
public static void isEmpty(Collection collection) {
isEmpty(collection, "[Assertion failed] - this array must have no elements");
}
/**
* Assert that a collection has elements.
*
* <pre class="code">
* Assert.notEmpty(collection, "Collection must have elements");
* </pre>
*
* @param collection the collection to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the collection is <code>null</code>
* or has no elements
*/
public static void notEmpty(Collection collection, String message) {
if (collection == null || collection.isEmpty()) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that a collection has elements.
*
* <pre class="code">
* Assert.notEmpty(collection, "Collection must have elements");
* </pre>
*
* @param collection the collection to check
* @throws IllegalArgumentException if the collection is <code>null</code>
* or has no elements
*/
public static void notEmpty(Collection collection) {
notEmpty(collection, "[Assertion failed] - this collection must contain at least 1 element");
}
/**
* Assert that a map must have no entries.
*
* <pre class="code">
* Assert.isEmpty(map, "Map must have no elements");
* </pre>
*
* @param map the map to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the map has any entries
*/
public static void isEmpty(Map map, String message) {
if (map != null && map.size() > 0) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that a map must have no entries.
*
* <pre class="code">
* Assert.notEmpty(map, "Map must have no elements");
* </pre>
*
* @param map the map to check
* @throws IllegalArgumentException if the map has any entries
*/
public static void isEmpty(Map map) {
isEmpty(map, "[Assertion failed] - this array must be null or empty");
}
/**
* Assert that a Map has entries.
*
* <pre class="code">
* Assert.notEmpty(map, "Map must have entries");
* </pre>
*
* @param map the map to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the map is <code>null</code> or has
* no entries
*/
public static void notEmpty(Map map, String message) {
if (map == null || map.isEmpty()) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that a Map has entries.
*
* <pre class="code">
* Assert.notEmpty(map);
* </pre>
*
* @param map the map to check
* @throws IllegalArgumentException if the map is <code>null</code> or has
* no entries
*/
public static void notEmpty(Map map) {
notEmpty(map, "[Assertion failed] - this map must have at least one entry");
}
/**
* 断言字符串为<code>null</code>、空字符串或者只包含空白字符串（空格、回车、换行、tab等字符） Assert that a
* character sequence is null, empty or contains blank characters only.
*
* @param text the character sequence to be checked
* @param message the exception message to display when the assertion failed
*/
public static void isBlank(CharSequence text, String message) {
if (StringUtils.isNotBlank(text)) {
throw new IllegalArgumentException(message);
}
}
/**
* 断言字符串为<code>null</code>、空字符串或者只包含空白字符串（空格、回车、换行、tab等字符） Assert that a
* character sequence is null, empty or contains blank characters only.
*
* @param text the character sequence to be checked
*/
public static void isBlank(CharSequence text) {
isBlank(text, "[Assertion failed] - this CharSequence argument must be null or blank");
}
/**
* 断言字符串text至少包含一个非空白字符串（空格、回车、换行、tab等空白字符之外的字符） Assert that a character
* sequence must have at least one not blank character.
*
* @param text the character sequence to be checked
* @param message the exception message to display when the assertion failed
*/
public static void notBlank(CharSequence text, String message) {
if (StringUtils.isBlank(text)) {
throw new IllegalArgumentException(message);
}
}
/**
* 断言字符串text至少包含一个非空白字符串（空格、回车、换行、tab等空白字符之外的字符） Assert that a character
* sequence must have at least one not blank character.
*
* @param text the character sequence to be checked
*/
public static void notBlank(CharSequence text) {
notBlank(text, "[Assertion failed] - this CharSequence argument must not be null or blank");
}
/**
* Assert that the given text contains the given substring.
*
* <pre class="code">
* Assert.containsText(name, "rod", "Name must contains
* 'rod'");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring to find within the text
* @param message the exception message to use if the assertion fails
*/
public static void containsText(String textToSearch, String substring,
String message) {
if (!StringUtils.isEmpty(textToSearch)
&& !StringUtils.isEmpty(substring)
&& textToSearch.indexOf(substring) == -1) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the given text contains the given substring.
*
* <pre class="code">
* Assert.containsText(name, "rod");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring to find within the text
*/
public static void containsText(String textToSearch, String substring) {
containsText(textToSearch, substring,
"[Assertion failed] - this String argument must contain the substring ["
+ substring + "]");
}
/**
* Assert that the given text does not contain the given substring.
*
* <pre class="code">
* Assert.notContainsText(name, "rod", "Name must not contain
* 'rod'");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring to find within the text
* @param message the exception message to use if the assertion fails
*/
public static void notContainsText(String textToSearch, String substring,
String message) {
if (!StringUtils.isEmpty(textToSearch)
&& !StringUtils.isEmpty(substring)
&& textToSearch.indexOf(substring) != -1) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the given text does not contain the given substring.
*
* <pre class="code">
* Assert.notContainsText(name, "rod");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring to find within the text
*/
public static void notContainsText(String textToSearch, String substring) {
notContainsText(textToSearch, substring,
"[Assertion failed] - this String argument must not contain the substring ["
+ substring + "]");
}
/**
* Assert that the given text starts with given substring.
*
* <pre class="code">
* Assert.startsWithText(name, "rod", "Name must starts with
* 'rod'");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring
* @param message the exception message to use if the assertion fails
*/
public static void startsWithText(String textToSearch, String substring,
String message) {
if (!StringUtils.isEmpty(textToSearch)
&& !StringUtils.isEmpty(substring)
&& !textToSearch.startsWith(substring)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the given text starts with given substring.
*
* <pre class="code">
* Assert.startsWithText(name, "rod");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring
*/
public static void startsWithText(String textToSearch, String substring) {
startsWithText(textToSearch, substring,
"[Assertion failed] - this String argument must start with the substring ["
+ substring + "]");
}
/**
* Assert that the given text not starts with the given substring.
*
* <pre class="code">
* Assert.notStartsWithText(name, "rod", "Name must not
* starts with 'rod'");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring
* @param message the exception message to use if the assertion fails
*/
public static void notStartsWithText(String textToSearch, String substring,
String message) {
if (!StringUtils.isEmpty(textToSearch)
&& !StringUtils.isEmpty(substring)
&& textToSearch.startsWith(substring)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the given text not starts with the given substring.
*
* <pre class="code">
* Assert.notStartsWithText(name, "rod");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring to find
*/
public static void notStartsWithText(String textToSearch, String substring) {
notStartsWithText(textToSearch, substring,
"[Assertion failed] - this String argument must not start with the substring ["
+ substring + "]");
}
/**
* Assert that the given text ends with given substring.
*
* <pre class="code">
* Assert.endsWithText(name, "rod", "Name must end with
* 'rod'");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring
* @param message the exception message to use if the assertion fails
*/
public static void endsWithText(String textToSearch, String substring,
String message) {
if (!StringUtils.isEmpty(textToSearch)
&& !StringUtils.isEmpty(substring)
&& !textToSearch.endsWith(substring)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the given text ends with given substring.
*
* <pre class="code">
* Assert.endsWithText(name, "rod");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring
*/
public static void endsWithText(String textToSearch, String substring) {
endsWithText(textToSearch, substring,
"[Assertion failed] - this String argument must end with the substring ["
+ substring + "]");
}
/**
* Assert that the given text must not end with the given substring.
*
* <pre class="code">
* Assert.notEndsWithText(name, "rod", "Name must not end
* with 'rod'");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring
* @param message the exception message to use if the assertion fails
*/
public static void notEndsWithText(String textToSearch, String substring,
String message) {
if (!StringUtils.isEmpty(textToSearch)
&& !StringUtils.isEmpty(substring)
&& textToSearch.endsWith(substring)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the given text not end with the given substring.
*
* <pre class="code">
* Assert.notEndsWithText(name, "rod");
* </pre>
*
* @param textToSearch the text to search
* @param substring the substring to find
*/
public static void notEndsWithText(String textToSearch, String substring) {
notEndsWithText(textToSearch, substring,
"[Assertion failed] - this String argument must not end with the substring ["
+ substring + "]");
}
/**
* Assert that an array has no null elements. Note: Does not complain if the
* array is empty!
*
* <pre class="code">
* Assert.noNullElements(array, "The array must have non-null
* elements");
* </pre>
*
* @param array the array to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object array contains a
* <code>null</code> element
*/
public static void noNullElements(Object[] array, String message) {
if (array == null) {
return;
}
for (Object each : array) {
notNull(each, message);
}
}
/**
* Assert that an array has no null elements. Note: Does not complain if the
* array is empty!
*
* <pre class="code">
* Assert.noNullElements(array);
* </pre>
*
* @param array the array to check
* @throws IllegalArgumentException if the object array contains a
* <code>null</code> element
*/
public static void noNullElements(Object[] array) {
noNullElements(array,
"[Assertion failed] - this array must not contain any null elements");
}
/**
* Assert that an collection has no null elements. Note: Does not complain if the
* collection is empty!
*
* <pre class="code">
* Assert.noNullElements(collection, "The collection must have non-null
* elements");
* </pre>
*
* @param collection the collection to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object array contains a
* <code>null</code> element
*/
public static void noNullElements(Collection collection, String message) {
if (collection == null) {
return;
}
for (Object each : collection) {
notNull(each, message);
}
}
/**
* Assert that an collection has no null elements. Note: Does not complain if the
* collection is empty!
*
* <pre class="code">
* Assert.noNullElements(collection);
* </pre>
*
* @param collection the collection to check
* @throws IllegalArgumentException if the object collection contains a
* <code>null</code> element
*/
public static void noNullElements(Collection collection) {
noNullElements(collection,
"[Assertion failed] - this array must not contain any null elements");
}
/**
* Assert that an map has no null elements. Note: Does not complain if the
* map is empty!
*
* <pre class="code">
* Assert.noNullElements(map, "The map must have non-null
* elements");
* </pre>
*
* @param map the map to check
* @param message the exception message to use if the assertion fails
* @throws IllegalArgumentException if the object array contains a
* <code>null</code> element
*/
public static void noNullElements(Map map, String message) {
if (map == null) {
return;
}
for (Object each : map.values()) {
notNull(each, message);
}
}
/**
* Assert that an map has no null elements. Note: Does not complain if the
* map is empty!
*
* <pre class="code">
* Assert.noNullElements(map);
* </pre>
*
* @param map the map to check
* @throws IllegalArgumentException if the object map contains a
* <code>null</code> element
*/
public static void noNullElements(Map map) {
noNullElements(map,
"[Assertion failed] - this map must not contain any null elements");
}
/**
* Assert that the provided object is an instance of the provided class.
*
* <pre class="code">
* Assert.isInstanceOf(Foo.class, foo, "The object must be instance of
* the type");
* </pre>
*
* @param type the type to check against
* @param obj the object to check
* @param 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.
* @throws IllegalArgumentException if the object is not an instance of
* clazz
* @see Class#isInstance
*/
public static void isInstanceOf(Class type, Object obj, String message) {
notNull(type, "Type to check against must not be null");
if (!type.isInstance(obj)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that the provided object is an instance of the provided class.
*
* <pre class="code">
* Assert.isInstanceOf(Foo.class, foo);
* </pre>
*
* @param type the required class
* @param obj the object to check
* @throws IllegalArgumentException if the object is not an instance of
* clazz
* @see Class#isInstance
*/
public static void isInstanceOf(Class type, Object obj) {
isInstanceOf(type, obj, "Object of class ["
+ (obj != null ? obj.getClass().getName() : "null")
+ "] must be an instance of " + type);
}
/**
* Assert that <code>superType.isAssignableFrom(subType)</code> is
* <code>true</code>.
*
* <pre class="code">
Assert.isAssignableFrom(Number.class, myClass, "The subType must be
* instance of the superType");
* </pre>
*
* @param superType the super type to check against
* @param subType the sub type to check
* @param 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.
* @throws IllegalArgumentException if the classes are not assignable
*/
@SuppressWarnings("unchecked")
public static void isAssignableFrom(Class superType, Class subType,
String message) {
notNull(superType, "Type to check against must not be null");
if (subType == null || !superType.isAssignableFrom(subType)) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that <code>superType.isAssignableFrom(subType)</code> is
* <code>true</code>.
*
* <pre class="code">
Assert.isAssignableFrom(Number.class, myClass);
</pre>
*
* @param superType the super type to check
* @param subType the sub type to check
* @throws IllegalArgumentException if the classes are not assignable
*/
public static void isAssignableFrom(Class superType, Class subType) {
isAssignableFrom(superType, subType, subType
+ " must be assignable to " + superType);
}
}