org.foxlabs.util

Class Assert

java.lang.Object

org.foxlabs.util.Assert

public abstract class Assert
extends Object

This class defines a number of methods that help to validate arguments.

For example:

   public void setName(String name) {
       this.name = Assert.notEmpty(name, "Name cannot be empty!");
   }
 

Author:

Fox Mulder

Constructor Summary

Constructors

Constructor and Description
Assert()

Method Summary

Methods

Modifier and Type	Method and Description
protected static IllegalArgumentException	assertError(String message) Returns IllegalArgumentException initialized with the specified message and with adjusted stack trace.
static void	assertFalse(boolean flag, String message) Throws IllegalArgumentException if the specified flag is true.
static void	assertTrue(boolean flag, String message) Throws IllegalArgumentException if the specified flag is false.
static String[]	noEmptyElements(String[] array, String message) Throws IllegalArgumentException if the specified array is null or empty or contains null or empty strings.
static <T extends Collection<String>> T	noEmptyElements(T collection, String message) Throws IllegalArgumentException if the specified collection is null or empty or contains null or empty strings.
static Set<String>	noEmptyStringSet(String[] array, String message) Throws IllegalArgumentException if the specified array is null or empty or contains null or empty strings.
static <T> T[]	noNullElements(T[] array, String message) Throws IllegalArgumentException if the specified array is null or empty or contains null elements.
static <T extends Collection<?>> T	noNullElements(T collection, String message) Throws IllegalArgumentException if the specified collection is null or empty or contains null elements.
static Set<String>	noNullStringSet(String[] array, String message) Throws IllegalArgumentException if the specified array is null or empty or contains null strings.
static String	notEmpty(String string, String message) Throws IllegalArgumentException if the specified string is null or empty.
static <T> T[]	notEmpty(T[] array, String message) Throws IllegalArgumentException if the specified array is null or empty.
static <T extends Collection<?>> T	notEmpty(T collection, String message) Throws IllegalArgumentException if the specified collection is null or empty.
static double	notNegative(double value, String message) Throws IllegalArgumentException if the specified double value is negative.
static float	notNegative(float value, String message) Throws IllegalArgumentException if the specified float value is negative.
static int	notNegative(int value, String message) Throws IllegalArgumentException if the specified int value is negative.
static long	notNegative(long value, String message) Throws IllegalArgumentException if the specified long value is negative.
static double	notNegativeOrZero(double value, String message) Throws IllegalArgumentException if the specified double value is negative or zero.
static float	notNegativeOrZero(float value, String message) Throws IllegalArgumentException if the specified float value is negative or zero.
static int	notNegativeOrZero(int value, String message) Throws IllegalArgumentException if the specified int value is negative or zero.
static long	notNegativeOrZero(long value, String message) Throws IllegalArgumentException if the specified long value is negative or zero.
static <T> T	notNull(T object, String message) Throws IllegalArgumentException if the specified object is null.

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 flag,
              String message)

Throws IllegalArgumentException if the specified flag is false.

Parameters:

flag - Test flag.

message - Exception message.

Throws:

IllegalArgumentException - if the specified flag is false.

assertFalse

public static void assertFalse(boolean flag,
               String message)

Throws IllegalArgumentException if the specified flag is true.

Parameters:

flag - Test flag.

message - Exception message.

Throws:

IllegalArgumentException - if the specified flag is true.

notNull

public static <T> T notNull(T object,
            String message)

Throws IllegalArgumentException if the specified object is null.

Parameters:

object - Object to test.

message - Exception message.

Returns:

The specified object.

Throws:

IllegalArgumentException - if the specified object is null.

notEmpty

public static String notEmpty(String string,
              String message)

Throws IllegalArgumentException if the specified string is null or empty.

Parameters:

string - String to test.

message - Exception message.

Returns:

The specified string.

Throws:

IllegalArgumentException - if the specified string is null or empty.

notEmpty

public static <T> T[] notEmpty(T[] array,
               String message)

Throws IllegalArgumentException if the specified array is null or empty.

Parameters:

array - Array to test.

message - Exception message.

Returns:

The specified array.

Throws:

IllegalArgumentException - if the specified array is null or empty.

notEmpty

public static <T extends Collection<?>> T notEmpty(T collection,
                                   String message)

Throws IllegalArgumentException if the specified collection is null or empty.

Parameters:

collection - Collection to test.

message - Exception message.

Returns:

The specified collection.

Throws:

IllegalArgumentException - if the specified collection is null or empty.

noNullElements

public static <T> T[] noNullElements(T[] array,
                     String message)

Throws IllegalArgumentException if the specified array is null or empty or contains null elements.

Parameters:

array - Array to test.

message - Exception message.

Returns:

The specified array.

Throws:

IllegalArgumentException - if the specified array is null or empty or contains null elements.

noNullElements

public static <T extends Collection<?>> T noNullElements(T collection,
                                         String message)

Throws IllegalArgumentException if the specified collection is null or empty or contains null elements.

Parameters:

collection - Collection to test.

message - Exception message.

Returns:

The specified collection.

Throws:

IllegalArgumentException - if the specified collection is null or empty or contains null elements.

noEmptyElements

public static String[] noEmptyElements(String[] array,
                       String message)

Throws IllegalArgumentException if the specified array is null or empty or contains null or empty strings.

Parameters:

array - Array to test.

message - Exception message.

Returns:

The specified array.

Throws:

IllegalArgumentException - if the specified array is null or empty or contains null or empty strings.

noEmptyElements

public static <T extends Collection<String>> T noEmptyElements(T collection,
                                               String message)

Throws IllegalArgumentException if the specified collection is null or empty or contains null or empty strings.

Parameters:

collection - Collection to test.

message - Exception message.

Returns:

The specified collection.

Throws:

IllegalArgumentException - if the specified collection is null or empty or contains null or empty strings.

noNullStringSet

public static Set<String> noNullStringSet(String[] array,
                          String message)

Throws IllegalArgumentException if the specified array is null or empty or contains null strings.

Parameters:

array - Array to test.

message - Exception message.

Returns:

Set of the specified strings.

Throws:

IllegalArgumentException - if the specified array is null or empty or contains null strings.

noEmptyStringSet

public static Set<String> noEmptyStringSet(String[] array,
                           String message)

Throws IllegalArgumentException if the specified array is null or empty or contains null or empty strings.

Parameters:

array - Array to test.

message - Exception message.

Returns:

Set of the specified strings.

Throws:

IllegalArgumentException - if the specified array is null or empty or contains null or empty strings.

notNegative

public static int notNegative(int value,
              String message)

Throws IllegalArgumentException if the specified int value is negative.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative.

notNegative

public static long notNegative(long value,
               String message)

Throws IllegalArgumentException if the specified long value is negative.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative.

notNegative

public static float notNegative(float value,
                String message)

Throws IllegalArgumentException if the specified float value is negative.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative.

notNegative

public static double notNegative(double value,
                 String message)

Throws IllegalArgumentException if the specified double value is negative.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative.

notNegativeOrZero

public static int notNegativeOrZero(int value,
                    String message)

Throws IllegalArgumentException if the specified int value is negative or zero.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative or zero.

notNegativeOrZero

public static long notNegativeOrZero(long value,
                     String message)

Throws IllegalArgumentException if the specified long value is negative or zero.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative or zero.

notNegativeOrZero

public static float notNegativeOrZero(float value,
                      String message)

Throws IllegalArgumentException if the specified float value is negative or zero.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative or zero.

notNegativeOrZero

public static double notNegativeOrZero(double value,
                       String message)

Throws IllegalArgumentException if the specified double value is negative or zero.

Parameters:

value - Value to test.

message - Exception message.

Returns:

The specified value.

Throws:

IllegalArgumentException - if the specified value is negative or zero.

assertError

protected static IllegalArgumentException assertError(String message)

Returns IllegalArgumentException initialized with the specified message and with adjusted stack trace.

Parameters:

message - Exception message.

Returns:

IllegalArgumentException.