/* * Copyright 2002-2020 the original author or authors. * * Licensed 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 * * https://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 org.springframework.util; import java.util.Collection; import java.util.Map; import java.util.function.Supplier; import org.springframework.lang.Nullable; /** * Assertion utility class that assists in validating arguments. * *
Useful for identifying programmer errors early and clearly at runtime. * *
For example, if the contract of a public method states it does not * allow {@code null} arguments, {@code Assert} can be used to validate that * contract. Doing this clearly indicates a contract violation when it * occurs and protects the class's invariants. * *
Typically used to validate method arguments rather than configuration * properties, to check for cases that are usually programmer errors rather * than configuration errors. In contrast to configuration initialization * code, there is usually no point in falling back to defaults in such methods. * *
This class is similar to JUnit's assertion library. If an argument value is * deemed invalid, an {@link IllegalArgumentException} is thrown (typically). * For example: * *
* Assert.notNull(clazz, "The class must not be null"); * Assert.isTrue(i > 0, "The value must be greater than zero");* *
Mainly for internal use within the framework; for a more comprehensive suite * of assertion utilities consider {@code org.apache.commons.lang3.Validate} from * Apache Commons Lang, * Google Guava's * Preconditions, * or similar third-party libraries. * * @author Keith Donald * @author Juergen Hoeller * @author Sam Brannen * @author Colin Sampaleanu * @author Rob Harrop * @since 1.1.2 */ public abstract class Assert { /** * Assert a boolean expression, throwing an {@code IllegalStateException} * if the expression evaluates to {@code false}. *
Call {@link #isTrue} if you wish to throw an {@code 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 {@code expression} is {@code false} */ public static void state(boolean expression, String message) { if (!expression) { throw new IllegalStateException(message); } } /** * Assert a boolean expression, throwing an {@code IllegalStateException} * if the expression evaluates to {@code false}. *
Call {@link #isTrue} if you wish to throw an {@code IllegalArgumentException} * on an assertion failure. *
* Assert.state(entity.getId() == null, * () -> "ID for entity " + entity.getName() + " must not already be initialized"); ** @param expression a boolean expression * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalStateException if {@code expression} is {@code false} * @since 5.0 */ public static void state(boolean expression, Supplier
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 {@code expression} is {@code false} */ public static void isTrue(boolean expression, String message) { if (!expression) { throw new IllegalArgumentException(message); } } /** * Assert a boolean expression, throwing an {@code IllegalArgumentException} * if the expression evaluates to {@code false}. *
* Assert.isTrue(i > 0, () -> "The value '" + i + "' must be greater than zero"); ** @param expression a boolean expression * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if {@code expression} is {@code false} * @since 5.0 */ public static void isTrue(boolean expression, Supplier
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 {@code null} */ public static void isNull(@Nullable Object object, String message) { if (object != null) { throw new IllegalArgumentException(message); } } /** * Assert that an object is {@code null}. *
* Assert.isNull(value, () -> "The value '" + value + "' must be null"); ** @param object the object to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the object is not {@code null} * @since 5.0 */ public static void isNull(@Nullable Object object, Supplier
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 {@code null} */ public static void notNull(@Nullable Object object, String message) { if (object == null) { throw new IllegalArgumentException(message); } } /** * Assert that an object is not {@code null}. *
* Assert.notNull(entity.getId(), * () -> "ID for entity " + entity.getName() + " must not be null"); ** @param object the object to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the object is {@code null} * @since 5.0 */ public static void notNull(@Nullable Object object, Supplier
Assert.hasLength(name, "Name must not be empty");* @param text the String to check * @param message the exception message to use if the assertion fails * @throws IllegalArgumentException if the text is empty * @see StringUtils#hasLength */ public static void hasLength(@Nullable String text, String message) { if (!StringUtils.hasLength(text)) { throw new IllegalArgumentException(message); } } /** * Assert that the given String is not empty; that is, * it must not be {@code null} and not the empty String. *
* Assert.hasLength(account.getName(), * () -> "Name for account '" + account.getId() + "' must not be empty"); ** @param text the String to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the text is empty * @since 5.0 * @see StringUtils#hasLength */ public static void hasLength(@Nullable String text, Supplier
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 * @throws IllegalArgumentException if the text does not contain valid text content * @see StringUtils#hasText */ public static void hasText(@Nullable String text, String message) { if (!StringUtils.hasText(text)) { throw new IllegalArgumentException(message); } } /** * Assert that the given String contains valid text content; that is, it must not * be {@code null} and must contain at least one non-whitespace character. *
* Assert.hasText(account.getName(), * () -> "Name for account '" + account.getId() + "' must not be empty"); ** @param text the String to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the text does not contain valid text content * @since 5.0 * @see StringUtils#hasText */ public static void hasText(@Nullable String text, Supplier
Assert.doesNotContain(name, "rod", "Name must not contain 'rod'");* @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 * @throws IllegalArgumentException if the text contains the substring */ public static void doesNotContain(@Nullable String textToSearch, String substring, String message) { if (StringUtils.hasLength(textToSearch) && StringUtils.hasLength(substring) && textToSearch.contains(substring)) { throw new IllegalArgumentException(message); } } /** * Assert that the given text does not contain the given substring. *
* Assert.doesNotContain(name, forbidden, () -> "Name must not contain '" + forbidden + "'"); ** @param textToSearch the text to search * @param substring the substring to find within the text * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the text contains the substring * @since 5.0 */ public static void doesNotContain(@Nullable String textToSearch, String substring, Supplier
Assert.notEmpty(array, "The array must contain 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 {@code null} or contains no elements */ public static void notEmpty(@Nullable Object[] array, String message) { if (ObjectUtils.isEmpty(array)) { throw new IllegalArgumentException(message); } } /** * Assert that an array contains elements; that is, it must not be * {@code null} and must contain at least one element. *
* Assert.notEmpty(array, () -> "The " + arrayType + " array must contain elements"); ** @param array the array to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the object array is {@code null} or contains no elements * @since 5.0 */ public static void notEmpty(@Nullable Object[] array, Supplier
Note: Does not complain if the array is empty! *
Assert.noNullElements(array, "The array must contain 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 {@code null} element */ public static void noNullElements(@Nullable Object[] array, String message) { if (array != null) { for (Object element : array) { if (element == null) { throw new IllegalArgumentException(message); } } } } /** * Assert that an array contains no {@code null} elements. *
Note: Does not complain if the array is empty! *
* Assert.noNullElements(array, () -> "The " + arrayType + " array must contain non-null elements"); ** @param array the array to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the object array contains a {@code null} element * @since 5.0 */ public static void noNullElements(@Nullable Object[] array, Supplier
Assert.notEmpty(collection, "Collection must contain elements");* @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} or * contains no elements */ public static void notEmpty(@Nullable Collection> collection, String message) { if (CollectionUtils.isEmpty(collection)) { throw new IllegalArgumentException(message); } } /** * Assert that a collection contains elements; that is, it must not be * {@code null} and must contain at least one element. *
* Assert.notEmpty(collection, () -> "The " + collectionType + " collection must contain elements"); ** @param collection the collection to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the collection is {@code null} or * contains no elements * @since 5.0 */ public static void notEmpty(@Nullable Collection> collection, Supplier
Note: Does not complain if the collection is empty! *
Assert.noNullElements(collection, "Collection must contain non-null elements");* @param collection the collection to check * @param message the exception message to use if the assertion fails * @throws IllegalArgumentException if the collection contains a {@code null} element * @since 5.2 */ public static void noNullElements(@Nullable Collection> collection, String message) { if (collection != null) { for (Object element : collection) { if (element == null) { throw new IllegalArgumentException(message); } } } } /** * Assert that a collection contains no {@code null} elements. *
Note: Does not complain if the collection is empty! *
* Assert.noNullElements(collection, () -> "Collection " + collectionName + " must contain non-null elements"); ** @param collection the collection to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the collection contains a {@code null} element * @since 5.2 */ public static void noNullElements(@Nullable Collection> collection, Supplier
Assert.notEmpty(map, "Map must contain entries");* @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} or contains no entries */ public static void notEmpty(@Nullable Map, ?> map, String message) { if (CollectionUtils.isEmpty(map)) { throw new IllegalArgumentException(message); } } /** * Assert that a Map contains entries; that is, it must not be {@code null} * and must contain at least one entry. *
* Assert.notEmpty(map, () -> "The " + mapType + " map must contain entries"); ** @param map the map to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails * @throws IllegalArgumentException if the map is {@code null} or contains no entries * @since 5.0 */ public static void notEmpty(@Nullable Map, ?> map, Supplier
Assert.instanceOf(Foo.class, foo, "Foo expected");* @param type the type to check against * @param obj the object to check * @param message a message which will be prepended to provide further context. * If it is empty or ends in ":" or ";" or "," or ".", a full exception message * will be appended. If it ends in a space, the name of the offending object's * type will be appended. In any other case, a ":" with a space and the name * of the offending object's type will be appended. * @throws IllegalArgumentException if the object is not an instance of type */ public static void isInstanceOf(Class> type, @Nullable Object obj, String message) { notNull(type, "Type to check against must not be null"); if (!type.isInstance(obj)) { instanceCheckFailed(type, obj, message); } } /** * Assert that the provided object is an instance of the provided class. *
* Assert.instanceOf(Foo.class, foo, () -> "Processing " + Foo.class.getSimpleName() + ":"); ** @param type the type to check against * @param obj the object to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails. See {@link #isInstanceOf(Class, Object, String)} for details. * @throws IllegalArgumentException if the object is not an instance of type * @since 5.0 */ public static void isInstanceOf(Class> type, @Nullable Object obj, Supplier
Assert.instanceOf(Foo.class, foo);* @param type the type to check against * @param obj the object to check * @throws IllegalArgumentException if the object is not an instance of type */ public static void isInstanceOf(Class> type, @Nullable Object obj) { isInstanceOf(type, obj, ""); } /** * Assert that {@code superType.isAssignableFrom(subType)} is {@code true}. *
Assert.isAssignable(Number.class, myClass, "Number expected");* @param superType the super type to check against * @param subType the sub type to check * @param message a message which will be prepended to provide further context. * If it is empty or ends in ":" or ";" or "," or ".", a full exception message * will be appended. If it ends in a space, the name of the offending sub type * will be appended. In any other case, a ":" with a space and the name of the * offending sub type will be appended. * @throws IllegalArgumentException if the classes are not assignable */ public static void isAssignable(Class> superType, @Nullable Class> subType, String message) { notNull(superType, "Super type to check against must not be null"); if (subType == null || !superType.isAssignableFrom(subType)) { assignableCheckFailed(superType, subType, message); } } /** * Assert that {@code superType.isAssignableFrom(subType)} is {@code true}. *
* Assert.isAssignable(Number.class, myClass, () -> "Processing " + myAttributeName + ":"); ** @param superType the super type to check against * @param subType the sub type to check * @param messageSupplier a supplier for the exception message to use if the * assertion fails. See {@link #isAssignable(Class, Class, String)} for details. * @throws IllegalArgumentException if the classes are not assignable * @since 5.0 */ public static void isAssignable(Class> superType, @Nullable Class> subType, Supplier
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, ""); } private static void instanceCheckFailed(Class> type, @Nullable Object obj, @Nullable String msg) { String className = (obj != null ? obj.getClass().getName() : "null"); String result = ""; boolean defaultMessage = true; if (StringUtils.hasLength(msg)) { if (endsWithSeparator(msg)) { result = msg + " "; } else { result = messageWithTypeName(msg, className); defaultMessage = false; } } if (defaultMessage) { result = result + ("Object of class [" + className + "] must be an instance of " + type); } throw new IllegalArgumentException(result); } private static void assignableCheckFailed(Class> superType, @Nullable Class> subType, @Nullable String msg) { String result = ""; boolean defaultMessage = true; if (StringUtils.hasLength(msg)) { if (endsWithSeparator(msg)) { result = msg + " "; } else { result = messageWithTypeName(msg, subType); defaultMessage = false; } } if (defaultMessage) { result = result + (subType + " is not assignable to " + superType); } throw new IllegalArgumentException(result); } private static boolean endsWithSeparator(String msg) { return (msg.endsWith(":") || msg.endsWith(";") || msg.endsWith(",") || msg.endsWith(".")); } private static String messageWithTypeName(String msg, @Nullable Object typeName) { return msg + (msg.endsWith(" ") ? "" : ": ") + typeName; } @Nullable private static String nullSafeGet(@Nullable Supplier