Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » util » [javadoc | source]
org.springframework.util
abstract public class: Assert [javadoc | source]
java.lang.Object
   org.springframework.util.Assert
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 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 (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; consider Jakarta's Commons Lang >= 2.0 for a more comprehensive suite of assertion utilities.
Method from org.springframework.util.Assert Summary:
doesNotContain,   doesNotContain,   hasLength,   hasLength,   hasText,   hasText,   isAssignable,   isAssignable,   isInstanceOf,   isInstanceOf,   isNull,   isNull,   isTrue,   isTrue,   noNullElements,   noNullElements,   notEmpty,   notEmpty,   notEmpty,   notEmpty,   notEmpty,   notEmpty,   notNull,   notNull,   state,   state
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.util.Assert Detail:
 public static  void doesNotContain(String textToSearch,
    String substring) 
    Assert that the given text does not contain the given substring.
    Assert.doesNotContain(name, "rod");
 public static  void doesNotContain(String textToSearch,
    String substring,
    String message) 
    Assert that the given text does not contain the given substring.
    Assert.doesNotContain(name, "rod", "Name must not contain 'rod'");
 public static  void hasLength(String text) 
    Assert that the given String is not empty; that is, it must not be null and not the empty String.
    Assert.hasLength(name);
 public static  void hasLength(String text,
    String message) 
    Assert that the given String is not empty; that is, it must not be null and not the empty String.
    Assert.hasLength(name, "Name must not be empty");
 public static  void hasText(String text) 
    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");
 public static  void hasText(String text,
    String 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");
 public static  void isAssignable(Class superType,
    Class subType) 
    Assert that superType.isAssignableFrom(subType) is true.
    Assert.isAssignable(Number.class, myClass);
 public static  void isAssignable(Class superType,
    Class subType,
    String message) 
    Assert that superType.isAssignableFrom(subType) is true.
    Assert.isAssignable(Number.class, myClass);
 public static  void isInstanceOf(Class clazz,
    Object obj) 
    Assert that the provided object is an instance of the provided class.
    Assert.instanceOf(Foo.class, foo);
 public static  void isInstanceOf(Class type,
    Object obj,
    String message) 
    Assert that the provided object is an instance of the provided class.
    Assert.instanceOf(Foo.class, foo);
 public static  void isNull(Object object) 
    Assert that an object is null .
    Assert.isNull(value);
 public static  void isNull(Object object,
    String message) 
    Assert that an object is null .
    Assert.isNull(value, "The value must be null");
 public static  void isTrue(boolean expression) 
    Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
    Assert.isTrue(i > 0);
 public static  void isTrue(boolean expression,
    String message) 
    Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
    Assert.isTrue(i > 0, "The value must be greater than zero");
 public static  void noNullElements(Object[] array) 
    Assert that an array has no null elements. Note: Does not complain if the array is empty!
    Assert.noNullElements(array);
 public static  void noNullElements(Object[] array,
    String message) 
    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");
 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.
    Assert.notEmpty(array);
 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.
    Assert.notEmpty(collection, "Collection must have elements");
 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.
    Assert.notEmpty(map);
 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.
    Assert.notEmpty(array, "The array must have elements");
 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.
    Assert.notEmpty(collection, "Collection must have elements");
 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.
    Assert.notEmpty(map, "Map must have entries");
 public static  void notNull(Object object) 
    Assert that an object is not null .
    Assert.notNull(clazz);
 public static  void notNull(Object object,
    String message) 
    Assert that an object is not null .
    Assert.notNull(clazz, "The class must not be null");
 public static  void state(boolean expression) 
 public static  void state(boolean expression,
    String message) 
    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");