Package com.alipay.sofa.common.utils
Class AssertUtil
java.lang.Object
com.alipay.sofa.common.utils.AssertUtil
Created by [email protected] on 16/9/19.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
Assert that the given String has valid text content; that is, it must not benull
and must contain at least one non-whitespace character.static void
Assert that the given String has valid text content; that is, it must not benull
and must contain at least one non-whitespace character.static void
isAssignable
(Class superType, Class subType) Assert thatsuperType.isAssignableFrom(subType)
istrue
.static void
isAssignable
(Class superType, Class subType, String message) Assert thatsuperType.isAssignableFrom(subType)
istrue
.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
Assert that an object isnull
.static void
Assert that an object isnull
.static void
isTrue
(boolean expression) Assert a boolean expression, throwingIllegalArgumentException
if the test result isfalse
.static void
Assert a boolean expression, throwingIllegalArgumentException
if the test result isfalse
.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
Assert that an array has elements; that is, it must not benull
and must have at least one element.static void
Assert that an array has elements; that is, it must not benull
and must have at least one element.static void
notEmpty
(Collection collection) Assert that a collection has elements; that is, it must not benull
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 benull
and must have at least one element.static void
Assert that a Map has entries; that is, it must not benull
and must have at least one entry.static void
Assert that a Map has entries; that is, it must not benull
and must have at least one entry.static void
Assert that an object is notnull
.static void
Assert that an object is notnull
.static void
state
(boolean expression) Assert a boolean expression, throwingIllegalStateException
if the test result isfalse
.static void
Assert a boolean expression, throwingIllegalStateException
if the test result isfalse
.
-
Constructor Details
-
AssertUtil
public AssertUtil()
-
-
Method Details
-
isTrue
Assert a boolean expression, throwingIllegalArgumentException
if the test result isfalse
.Assert.isTrue(i > 0, "The value must be greater than zero");
- Parameters:
expression
- a boolean expressionmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if expression isfalse
-
isTrue
public static void isTrue(boolean expression) Assert a boolean expression, throwingIllegalArgumentException
if the test result isfalse
.Assert.isTrue(i > 0);
- Parameters:
expression
- a boolean expression- Throws:
IllegalArgumentException
- if expression isfalse
-
isNull
Assert that an object isnull
.Assert.isNull(value, "The value must be null");
- Parameters:
object
- the object to checkmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if the object is notnull
-
isNull
Assert that an object isnull
.Assert.isNull(value);
- Parameters:
object
- the object to check- Throws:
IllegalArgumentException
- if the object is notnull
-
notNull
Assert that an object is notnull
.Assert.notNull(clazz, "The class must not be null");
- Parameters:
object
- the object to checkmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if the object isnull
-
notNull
Assert that an object is notnull
.Assert.notNull(clazz);
- Parameters:
object
- the object to check- Throws:
IllegalArgumentException
- if the object isnull
-
notEmpty
Assert that an array has elements; that is, it must not benull
and must have at least one element.Assert.notEmpty(array, "The array must have elements");
- Parameters:
array
- the array to checkmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if the object array isnull
or has no elements
-
notEmpty
Assert that an array has elements; that is, it must not benull
and must have at least one element.Assert.notEmpty(array);
- Parameters:
array
- the array to check- Throws:
IllegalArgumentException
- if the object array isnull
or has no elements
-
noNullElements
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");
- Parameters:
array
- the array to checkmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if the object array contains anull
element
-
noNullElements
Assert that an array has no null elements. Note: Does not complain if the array is empty!Assert.noNullElements(array);
- Parameters:
array
- the array to check- Throws:
IllegalArgumentException
- if the object array contains anull
element
-
notEmpty
Assert that a collection has elements; that is, it must not benull
and must have at least one element.Assert.notEmpty(collection, "Collection must have elements");
- Parameters:
collection
- the collection to checkmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if the collection isnull
or has no elements
-
notEmpty
Assert that a collection has elements; that is, it must not benull
and must have at least one element.Assert.notEmpty(collection, "Collection must have elements");
- Parameters:
collection
- the collection to check- Throws:
IllegalArgumentException
- if the collection isnull
or has no elements
-
notEmpty
Assert that a Map has entries; that is, it must not benull
and must have at least one entry.Assert.notEmpty(map, "Map must have entries");
- Parameters:
map
- the map to checkmessage
- the exception message to use if the assertion fails- Throws:
IllegalArgumentException
- if the map isnull
or has no entries
-
notEmpty
Assert that a Map has entries; that is, it must not benull
and must have at least one entry.Assert.notEmpty(map);
- Parameters:
map
- the map to check- Throws:
IllegalArgumentException
- if the map isnull
or has no entries
-
isInstanceOf
Assert that the provided object is an instance of the provided class.Assert.instanceOf(Foo.class, foo);
- Parameters:
clazz
- the required classobj
- the object to check- Throws:
IllegalArgumentException
- if the object is not an instance of clazz- See Also:
-
isInstanceOf
Assert that the provided object is an instance of the provided class.Assert.instanceOf(Foo.class, foo);
- Parameters:
type
- the type to check againstobj
- the object to checkmessage
- 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 Also:
-
isAssignable
Assert thatsuperType.isAssignableFrom(subType)
istrue
.Assert.isAssignable(Number.class, myClass);
- Parameters:
superType
- the super type to checksubType
- the sub type to check- Throws:
IllegalArgumentException
- if the classes are not assignable
-
isAssignable
Assert thatsuperType.isAssignableFrom(subType)
istrue
.Assert.isAssignable(Number.class, myClass);
- Parameters:
superType
- the super type to check againstsubType
- the sub type to checkmessage
- 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
-
state
Assert a boolean expression, throwingIllegalStateException
if the test result isfalse
. Call isTrue if you wish to throw IllegalArgumentException on an assertion failure.Assert.state(id == null, "The id property must not already be initialized");
- Parameters:
expression
- a boolean expressionmessage
- the exception message to use if the assertion fails- Throws:
IllegalStateException
- if expression isfalse
-
state
public static void state(boolean expression) Assert a boolean expression, throwingIllegalStateException
if the test result isfalse
.Call
isTrue(boolean)
if you wish to throwIllegalArgumentException
on an assertion failure.Assert.state(id == null);
- Parameters:
expression
- a boolean expression- Throws:
IllegalStateException
- if the supplied expression isfalse
-
hasText
Assert that the given String has valid text content; that is, it must not benull
and must contain at least one non-whitespace character.Assert.hasText(name, "'name' must not be empty");
- Parameters:
text
- the String to checkmessage
- the exception message to use if the assertion fails
-
hasText
Assert that the given String has valid text content; that is, it must not benull
and must contain at least one non-whitespace character.Assert.hasText(name, "'name' must not be empty");
- Parameters:
text
- the String to check
-