org.gbif.ws.util.spring

Class Assert

java.lang.Object

org.gbif.ws.util.spring.Assert

public abstract class Assert
extends Object

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.

Since:

1.1.2

Author:

Keith Donald, Juergen Hoeller, Colin Sampaleanu, Rob Harrop

Constructor Summary

Constructors

Constructor and Description
Assert()

Method Summary

Modifier and Type	Method and Description
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.
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.
static void	isNull(Object object) Assert that an object is null .
static void	isNull(Object object, String message) Assert that an object is null .
static void	isTrue(boolean expression) Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
static void	isTrue(boolean expression, String message) Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
static void	notNull(Object object) Assert that an object is not null .
static void	notNull(Object object, String message) Assert that an object is not null .

Methods inherited from class java.lang.Object

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

Constructor Detail

Assert

public Assert()

Method Detail

isTrue

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");

Parameters:

expression - a boolean expression

message - the exception message to use if the assertion fails

Throws:

IllegalArgumentException - if expression is false

isTrue

public static void isTrue(boolean expression)

Assert a boolean expression, throwing IllegalArgumentException if the test result is false.

Assert.isTrue(i > 0);

Parameters:

expression - a boolean expression

Throws:

IllegalArgumentException - if expression is false

isNull

public static void isNull(Object object,
                          String message)

Assert that an object is null .

Assert.isNull(value, "The value must be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

Throws:

IllegalArgumentException - if the object is not null

isNull

public static void isNull(Object object)

Assert that an object is null .

Assert.isNull(value);

Parameters:

object - the object to check

Throws:

IllegalArgumentException - if the object is not null

notNull

public static void notNull(Object object,
                           String message)

Assert that an object is not null .

Assert.notNull(clazz, "The class must not be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

Throws:

IllegalArgumentException - if the object is null

notNull

public static void notNull(Object object)

Assert that an object is not null .

Assert.notNull(clazz);

Parameters:

object - the object to check

Throws:

IllegalArgumentException - if the object is null

hasText

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");

Parameters:

text - the String to check

message - the exception message to use if the assertion fails

hasText

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");

Parameters:

text - the String to check