com.alipay.sofa.common.utils.AssertUtil Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.alipay.sofa.common.utils;
import java.util.Collection;
import java.util.Map;
/**
* Created by [email protected] on 16/9/19.
*/
public abstract class AssertUtil {
/**
* Assert a boolean expression, throwing IllegalArgumentException
* if the test result is false.
* Assert.isTrue(i > 0, "The value must be greater than zero");
*
* @param expression a boolean expression
* @param message the exception message to use if the assertion fails
*
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression, String message) {
if (!expression) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert a boolean expression, throwing IllegalArgumentException
* if the test result is false.
* Assert.isTrue(i > 0);
*
* @param expression a boolean expression
*
* @throws IllegalArgumentException if expression is false
*/
public static void isTrue(boolean expression) {
isTrue(expression, "[Assertion failed] - this expression must be true");
}
/**
* Assert that an object is null .
* Assert.isNull(value, "The value must be null");
*
* @param object the object to check
* @param message the exception message to use if the assertion fails
*
* @throws IllegalArgumentException if the object is not null
*/
public static void isNull(Object object, String message) {
if (object != null) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that an object is null .
* Assert.isNull(value);
*
* @param object the object to check
*
* @throws IllegalArgumentException if the object is not null
*/
public static void isNull(Object object) {
isNull(object, "[Assertion failed] - the object argument must be null");
}
/**
* Assert that an object is not null .
* Assert.notNull(clazz, "The class must not be null");
*
* @param object the object to check
* @param message the exception message to use if the assertion fails
*
* @throws IllegalArgumentException if the object is null
*/
public static void notNull(Object object, String message) {
if (object == null) {
throw new IllegalArgumentException(message);
}
}
/**
* Assert that an object is not null .
* Assert.notNull(clazz);
*
* @param object the object to check
*
* @throws IllegalArgumentException if the object is null
*/
public static void notNull(Object object) {
notNull(object, "[Assertion failed] - this argument is required; it must not be null");
}
/**
* 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");
*
* @param array the array to check
* @param message the exception message to use if the assertion fails
*
* @throws IllegalArgumentException if the object array is null 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 elements; that is, it must not be
* null and must have at least one element.
* Assert.notEmpty(array);
*
* @param array the array to check
*
* @throws IllegalArgumentException if the object array is null 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 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");
*
* @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 null element
*/
public static void noNullElements(Object[] array, String message) {
if (array != null) {
for (int i = 0; i < array.length; i++) {
if (array[i] == null) {
throw new IllegalArgumentException(message);
}
}
}
}
/**
* Assert that an array has no null elements.
* Note: Does not complain if the array is empty!
* Assert.noNullElements(array);
*
* @param array the array to check
*
* @throws IllegalArgumentException if the object array contains a null element
*/
public static void noNullElements(Object[] array) {
noNullElements(array, "[Assertion failed] - this array must not contain any null elements");
}
/**
* 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");
*
* @param collection the collection to check
* @param message the exception message to use if the assertion fails
*
* @throws IllegalArgumentException if the collection is null 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; that is, it must not be
* null and must have at least one element.
* Assert.notEmpty(collection, "Collection must have elements");
*
* @param collection the collection to check
*
* @throws IllegalArgumentException if the collection is null or has no elements
*/
public static void notEmpty(Collection collection) {
notEmpty(collection,
"[Assertion failed] - this collection must not be empty: it must contain at least 1 element");
}
/**
* 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");
*
* @param map the map to check
* @param message the exception message to use if the assertion fails
*
* @throws IllegalArgumentException if the map is null 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; that is, it must not be null
* and must have at least one entry.
* Assert.notEmpty(map);
*
* @param map the map to check
*
* @throws IllegalArgumentException if the map is null or has no entries
*/
public static void notEmpty(Map map) {
notEmpty(map,
"[Assertion failed] - this map must not be empty; it must contain at least one entry");
}
/**
* Assert that the provided object is an instance of the provided class.
* Assert.instanceOf(Foo.class, foo);
*
* @param clazz 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 clazz, Object obj) {
isInstanceOf(clazz, obj, "");
}
/**
* Assert that the provided object is an instance of the provided class.
* Assert.instanceOf(Foo.class, foo);
*
* @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 + "Object of class ["
+ (obj != null ? obj.getClass().getName() : "null")
+ "] must be an instance of " + type);
}
}
/**
* Assert that superType.isAssignableFrom(subType) is true.
* Assert.isAssignable(Number.class, myClass);
*
* @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 isAssignable(Class superType, Class subType) {
isAssignable(superType, subType, "");
}
/**
* Assert that superType.isAssignableFrom(subType) is true.
* Assert.isAssignable(Number.class, myClass);
*
* @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
*/
public static void isAssignable(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 + subType + " is not assignable to "
+ superType);
}
}
/**
* 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");
*
* @param expression a boolean expression
* @param message the exception message to use if the assertion fails
*
* @throws IllegalStateException if expression is false
*/
public static void state(boolean expression, String message) {
if (!expression) {
throw new IllegalStateException(message);
}
}
/**
* Assert a boolean expression, throwing {@link IllegalStateException}
* if the test result is false.
* Call {@link #isTrue(boolean)} if you wish to
* throw {@link IllegalArgumentException} on an assertion failure.
*
Assert.state(id == null);
*
* @param expression a boolean expression
*
* @throws IllegalStateException if the supplied expression is false
*/
public static void state(boolean expression) {
state(expression, "[Assertion failed] - this state invariant must be true");
}
/**
* 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");
*
* @param text the String to check
* @param message the exception message to use if the assertion fails
*
*/
public static void hasText(String text, String message) {
if (!hasText0(text)) {
throw new IllegalArgumentException(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");
*
* @param text the String to check
*
*/
public static void hasText(String text) {
hasText(text,
"[Assertion failed] - this String argument must have text; it must not be null, empty, or blank");
}
private static boolean hasText0(CharSequence str) {
if (str != null && str.length() > 0) {
int strLen = str.length();
for (int i = 0; i < strLen; i++) {
if (!Character.isWhitespace(str.charAt(i))) {
return true;
}
}
}
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy