org.clafer.common

Class Check

java.lang.Object

org.clafer.common.Check

public class Check
extends Object

Various static utility functions for checking input.

Author:

jimmy

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T[]	noNulls(T... array)
static <T extends Iterable<T>> T	noNulls(T items)
static <T> T[]	noNullsNotEmpty(T... array)
static <T extends Iterable<T>> T	noNullsNotEmpty(T items)
static <T> T	notNull(String message, T obj) Check that the item is non-null.
static <T> T	notNull(T obj) Check that the item is non-null.

Methods inherited from class java.lang.Object

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

Method Detail

notNull

public static <T> T notNull(String message,
            T obj)
                 throws NullPointerException

Check that the item is non-null.

Type Parameters:

T - the type of the object

Parameters:

message - the message of the exception if thrown

obj - the object to check

Returns:

the original object

Throws:

NullPointerException - if the object is null

notNull

public static <T> T notNull(T obj)
                 throws NullPointerException

Check that the item is non-null.

Type Parameters:

T - the type of the object

Parameters:

obj - the item to check

Returns:

the original object

Throws:

NullPointerException - if the object is null

noNulls

public static <T> T[] noNulls(T... array)
                   throws NullPointerException

Type Parameters:

T - the type of the elements

Parameters:

array - not null and cannot contain null

Returns:

the original array

Throws:

NullPointerException - if the array is null or contains a null element

noNulls

public static <T extends Iterable<T>> T noNulls(T items)
                                  throws NullPointerException

Type Parameters:

T - the type of the elements

Parameters:

items - not null and cannot contain null

Returns:

the original items

Throws:

NullPointerException - if the items is null or contains a null element

noNullsNotEmpty

public static <T> T[] noNullsNotEmpty(T... array)
                           throws IllegalArgumentException,
                                  NullPointerException

Type Parameters:

T - the type of the elements

Parameters:

array - not null, cannot contain null, and is non-empty

Returns:

the original array

Throws:

IllegalArgumentException - if the array is empty

NullPointerException - if the array is null or contains a null element

noNullsNotEmpty

public static <T extends Iterable<T>> T noNullsNotEmpty(T items)
                                          throws IllegalArgumentException,
                                                 NullPointerException

Type Parameters:

T - the type of the elements

Parameters:

items - not null, cannot contain null, and is non-empty

Returns:

the original items

Throws:

IllegalArgumentException - if the items is empty

NullPointerException - if the items is null or contains a null element