| java.lang.Object
 org.strecks.util.Assert
| Assert | | abstract public class Assert (Code) | | Assert utility class taken originally from Spring framework library. Assists in validating
arguments. Useful for identifying programmer errors early and obviously at runtime.
For example, if the contract of a public method states it does not allow null arguments, 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 config
initialization code, there is usally 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
IllegalArgumentException is thrown. 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; consider Jakarta's Commons Lang >= 2.0 for a more
comprehensive suite of assertion utilities.
Phil Zoio: copied source and removed methods not used. Done so that Spring is not mandatory in
distribution.
author:
Keith Donald
author:
Juergen Hoeller
author:
Colin Sampaleanu
author:
Phil Zoio
since:
1.1.2 |
| Method Summary | |
| public static void | isInstanceOf(Class clazz, Object obj)
Assert that the provided object is an instance of the provided class. | | public static void | isInstanceOf(Class clazz, Object obj, String message)
Assert that the provided object is an instance of the provided class.
Assert.instanceOf(Foo.class, foo);
Parameters:
clazz - the required class
Parameters:
obj - the object to check
Parameters:
message - a message which will be prepended to the message produced by the function itself,and which may be used to provide context. | | public static void | isTrue(boolean expression, String message)
Assert a boolean expression, throwing IllegalArgumentException if the test
result is false. | | public static void | notEmpty(Object[] array, String message)
Assert that an array has elements; that is, it must not be null and must have
at least one element. | | public static void | notEmpty(Object[] array)
Assert that an array has elements; that is, it must not be null and must have
at least one element. | | public static void | notEmpty(Collection collection, String message)
Assert that a collection has elements; that is, it must not be null and must
have at least one element. | | public static void | notEmpty(Collection collection)
Assert that a collection has elements; that is, it must not be null and must
have at least one element. | | public static void | notEmpty(Map map, String message)
Assert that a Map has entries; that is, it must not be null and must have at
least one entry. | | public static void | notEmpty(Map map)
Assert that a Map has entries; that is, it must not be null and must have at
least one entry. | | public static void | notNull(Object object, String message)
Assert that an object is not null. | | public static void | notNull(Object object)
Assert that an object is not null. |
| isInstanceOf | | public static void isInstanceOf(Class clazz, Object obj)(Code) | | Assert that the provided object is an instance of the provided class.
Assert.instanceOf(Foo.class, foo);
Parameters:
clazz - the required class
Parameters:
obj - the object to check
throws:
IllegalArgumentException - if the object is not an instance of clazz
See Also: Class.isInstance |
| isInstanceOf | | public static void isInstanceOf(Class clazz, Object obj, String message)(Code) | | Assert that the provided object is an instance of the provided class.
Assert.instanceOf(Foo.class, foo);
Parameters:
clazz - the required class
Parameters:
obj - the object to check
Parameters:
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 Also: Class.isInstance |
| isTrue | | public static void isTrue(boolean expression, String message)(Code) | | Assert a boolean expression, throwing IllegalArgumentException if the test
result is false.
Assert.isTrue(i > 0, "The value must be greater than zero");
Parameters:
expression - a boolean expression
Parameters:
message - the exception message to use if the assertion fails
throws:
IllegalArgumentException - if expression is false |
| notEmpty | | public static void notEmpty(Object[] array, String message)(Code) | | 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");
Parameters:
array - the array to check
Parameters:
message - the exception message to use if the assertion fails
throws:
IllegalArgumentException - if the object array is null or has no elements |
| notEmpty | | public static void notEmpty(Object[] array)(Code) | | Assert that an array has elements; that is, it must not be null and must have
at least one element.
Assert.notEmpty(array);
Parameters:
array - the array to check
throws:
IllegalArgumentException - if the object array is null or has no elements |
| notEmpty | | public static void notEmpty(Collection collection, String message)(Code) | | 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");
Parameters:
collection - the collection to check
Parameters:
message - the exception message to use if the assertion fails
throws:
IllegalArgumentException - if the collection is null or has no elements |
| notEmpty | | public static void notEmpty(Collection collection)(Code) | | 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");
Parameters:
collection - the collection to check
throws:
IllegalArgumentException - if the collection is null or has no elements |
| notEmpty | | public static void notEmpty(Map map, String message)(Code) | | 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");
Parameters:
map - the map to check
Parameters:
message - the exception message to use if the assertion fails
throws:
IllegalArgumentException - if the map is null or has no entries |
| notEmpty | | public static void notEmpty(Map map)(Code) | | Assert that a Map has entries; that is, it must not be null and must have at
least one entry.
Assert.notEmpty(map);
Parameters:
map - the map to check
throws:
IllegalArgumentException - if the map is null or has no entries |
| notNull | | public static void notNull(Object object, String message)(Code) | | Assert that an object is not null.
Assert.notNull(clazz, "The class must not be null");
Parameters:
object - the object to check
Parameters:
message - the exception message to use if the assertion fails
throws:
IllegalArgumentException - if the object is null |
| notNull | | public static void notNull(Object object)(Code) | | Assert that an object is not null.
Assert.notNull(clazz);
Parameters:
object - the object to check
throws:
IllegalArgumentException - if the object is null |
|
|