Package io.microsphere.util

Class Assert

java.lang.Object

io.microsphere.util.BaseUtils

io.microsphere.util.Assert

public abstract class Assert
extends BaseUtils

The utility class for Assertion

Since:

1.0.0

Author:

Mercy

Constructor Summary

Constructors

Constructor	Description
Assert()

Method Summary

Modifier and Type	Method	Description
static void	assertNoNullElements(java.lang.Iterable<?> elements, java.lang.String message)	Assert that a elements contains no null elements.
static void	assertNoNullElements(java.lang.Iterable<?> elements, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that a elements contains no null elements.
static void	assertNoNullElements(java.lang.Object[] array, java.lang.String message)	Assert that an array contains no null elements.
static void	assertNoNullElements(java.lang.Object[] array, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that an array contains no null elements.
static void	assertNotEmpty(java.lang.Object[] array, java.lang.String message)	Assert that an array contains elements; that is, it must not be null and must contain at least one element.
static void	assertNotEmpty(java.lang.Object[] array, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that an array contains elements; that is, it must not be null and must contain at least one element.
static void	assertNotEmpty(java.util.Collection<?> collection, java.lang.String message)	Assert that a collection contains elements; that is, it must not be null and must contain at least one element.
static void	assertNotEmpty(java.util.Collection<?> collection, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that a collection contains elements; that is, it must not be null and must contain at least one element.
static void	assertNotEmpty(java.util.Map<?,?> map, java.lang.String message)	Assert that a Map contains entries; that is, it must not be null and must contain at least one entry.
static void	assertNotEmpty(java.util.Map<?,?> map, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that a Map contains entries; that is, it must not be null and must contain at least one entry.
static void	assertNotNull(java.lang.Object object, java.lang.String message)	Assert that an object is not null.
static void	assertNotNull(java.lang.Object object, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that an object is not null.
static void	assertNull(java.lang.Object object, java.lang.String message)	Assert that an object is null.
static void	assertNull(java.lang.Object object, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert that an object is null.
static void	assertTrue(boolean expression, java.lang.String message)	Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.
static void	assertTrue(boolean expression, java.util.function.Supplier<java.lang.String> messageSupplier)	Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assert

public Assert()

Method Detail

assertTrue

public static void assertTrue(boolean expression,
                              java.lang.String message)

Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

assertTrue(i > 0, "The value must be greater than zero");

Parameters:

expression - a boolean expression

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if expression is false

assertTrue

public static void assertTrue(boolean expression,
                              java.util.function.Supplier<java.lang.String> messageSupplier)

Assert a boolean expression, throwing an IllegalArgumentException if the expression evaluates to false.

 assertTrue(i > 0, () -> "The value '" + i + "' must be greater than zero");
 

Parameters:

expression - a boolean expression

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if expression is false

assertNull

public static void assertNull(@Nullable
                              java.lang.Object object,
                              java.lang.String message)

Assert that an object is null.

assertNull(value, "The value must be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object is not null

assertNull

public static void assertNull(@Nullable
                              java.lang.Object object,
                              java.util.function.Supplier<java.lang.String> messageSupplier)

Assert that an object is null.

 assertNull(value, () -> "The value '" + value + "' must be null");
 

Parameters:

object - the object to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object is not null

assertNotNull

public static void assertNotNull(@Nullable
                                 java.lang.Object object,
                                 java.lang.String message)

Assert that an object is not null.

assertNotNull(clazz, "The class must not be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object is null

assertNotNull

public static void assertNotNull(@Nullable
                                 java.lang.Object object,
                                 java.util.function.Supplier<java.lang.String> messageSupplier)

Assert that an object is not null.

 assertNotNull(entity.getId(), () -> "ID for entity " + entity.getName() + " must not be null");
 

Parameters:

object - the object to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object is null

assertNotEmpty

public static void assertNotEmpty(@Nullable
                                  java.lang.Object[] array,
                                  java.lang.String message)

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

assertNotEmpty(array, "The array must contain elements");

Parameters:

array - the array to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object array is null or contains no elements

assertNotEmpty

public static void assertNotEmpty(@Nullable
                                  java.lang.Object[] array,
                                  java.util.function.Supplier<java.lang.String> messageSupplier)

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

 assertNotEmpty(array, () -> "The " + arrayType + " array must contain elements");
 

Parameters:

array - the array to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object array is null or contains no elements

assertNotEmpty

public static void assertNotEmpty(@Nullable
                                  java.util.Collection<?> collection,
                                  java.lang.String message)

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

assertNotEmpty(collection, "Collection must contain elements");

Parameters:

collection - the collection to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the collection is null or contains no elements

assertNotEmpty

public static void assertNotEmpty(@Nullable
                                  java.util.Collection<?> collection,
                                  java.util.function.Supplier<java.lang.String> messageSupplier)

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

 assertNotEmpty(collection, () -> "The " + collectionType + " collection must contain elements");
 

Parameters:

collection - the collection to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the collection is null or contains no elements

assertNotEmpty

public static void assertNotEmpty(@Nullable
                                  java.util.Map<?,?> map,
                                  java.lang.String message)

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

assertNotEmpty(map, "Map must contain entries");

Parameters:

map - the map to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the map is null or contains no entries

assertNotEmpty

public static void assertNotEmpty(@Nullable
                                  java.util.Map<?,?> map,
                                  java.util.function.Supplier<java.lang.String> messageSupplier)

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

 assertNotEmpty(map, () -> "The " + mapType + " map must contain entries");
 

Parameters:

map - the map to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the map is null or contains no entries

assertNoNullElements

public static void assertNoNullElements(@Nullable
                                        java.lang.Object[] array,
                                        java.lang.String message)

Assert that an array contains no null elements.

Note: Does not complain if the array is empty!

assertNoNullElements(array, "The array must contain non-null elements");

Parameters:

array - the array to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object array contains a null element

assertNoNullElements

public static void assertNoNullElements(@Nullable
                                        java.lang.Object[] array,
                                        java.util.function.Supplier<java.lang.String> messageSupplier)

Assert that an array contains no null elements.

Note: Does not complain if the array is empty!

 assertNoNullElements(array, () -> "The " + arrayType + " array must contain non-null elements");
 

Parameters:

array - the array to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the object array contains a null element

assertNoNullElements

public static void assertNoNullElements(@Nullable
                                        java.lang.Iterable<?> elements,
                                        java.lang.String message)

Assert that a elements contains no null elements.

Note: Does not complain if the elements is empty!

assertNoNullElements(elements, "Elements must contain non-null elements");

Parameters:

elements - the elements to check

message - the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the elements contains a null element

assertNoNullElements

public static void assertNoNullElements(@Nullable
                                        java.lang.Iterable<?> elements,
                                        java.util.function.Supplier<java.lang.String> messageSupplier)

Assert that a elements contains no null elements.

Note: Does not complain if the elements is empty!

 assertNoNullElements(elements, () -> "Collection " + collectionName + " must contain non-null elements");
 

Parameters:

elements - the elements to check

messageSupplier - a supplier for the exception message to use if the assertion fails

Throws:

java.lang.IllegalArgumentException - if the elements contains a null element