com.amazon.ask.util

Class ValidationUtils

java.lang.Object

com.amazon.ask.util.ValidationUtils

public final class ValidationUtils
extends Object

Useful utilities to validate dependencies.

Method Summary

Modifier and Type	Method and Description
static void	assertAllAreNull(String messageIfNull, Object... objects) Asserts that all of the objects are null.
static int	assertIsPositive(int num, String fieldName) Asserts that the given number is positive (non-negative and non-zero).
static <T> T[]	assertNotEmpty(T[] array, String fieldName) Asserts that the given array is not empty (non-null and non-empty).
static <T extends Collection<?>> T	assertNotEmpty(T collection, String fieldName) Asserts that the given collection is not empty (non-null and non-empty).
static <T> T	assertNotNull(T object, String fieldName) Asserts that the given object is non-null and returns it.
static String	assertStringNotEmpty(String string, String fieldName) Asserts that the given string is not empty (non-null and non-empty).

Methods inherited from class java.lang.Object

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

Method Detail

assertNotNull

public static <T> T assertNotNull(T object,
                                  String fieldName)
                           throws IllegalArgumentException

Asserts that the given object is non-null and returns it.

Type Parameters:

T - type to evaluate

Parameters:

object - Object to assert on

fieldName - Field name to display in exception message if null

Returns:

Object if non null

Throws:

IllegalArgumentException - If object was null

assertAllAreNull

public static void assertAllAreNull(String messageIfNull,
                                    Object... objects)
                             throws IllegalArgumentException

Asserts that all of the objects are null.

Parameters:

messageIfNull - exception message to return if null

objects - objects to evaluate

Throws:

IllegalArgumentException - if any object provided was NOT null.

assertIsPositive

public static int assertIsPositive(int num,
                                   String fieldName)

Asserts that the given number is positive (non-negative and non-zero).

Parameters:

num - Number to validate

fieldName - Field name to display in exception message if not positive.

Returns:

Number if positive.

assertNotEmpty

public static <T extends Collection<?>> T assertNotEmpty(T collection,
                                                         String fieldName)
                                                  throws IllegalArgumentException

Asserts that the given collection is not empty (non-null and non-empty).

Type Parameters:

T - type of elements in given collection.

Parameters:

collection - collection to validate.

fieldName - field name to display in exception message if empty.

Returns:

collection if non-empty.

Throws:

IllegalArgumentException - if the collection provided was empty.

assertNotEmpty

public static <T> T[] assertNotEmpty(T[] array,
                                     String fieldName)
                              throws IllegalArgumentException

Asserts that the given array is not empty (non-null and non-empty).

Type Parameters:

T - type of elements in given array.

Parameters:

array - array to validate.

fieldName - field name to display in exception message if empty.

Returns:

array if non-empty.

Throws:

IllegalArgumentException - if the array provided was empty.

assertStringNotEmpty

public static String assertStringNotEmpty(String string,
                                          String fieldName)
                                   throws IllegalArgumentException

Asserts that the given string is not empty (non-null and non-empty).

Parameters:

string - string to validate.

fieldName - field name to display in exception message if empty.

Returns:

string if non-empty.

Throws:

IllegalArgumentException - if the string provided was empty.