com.github.mjeanroy.junit.servers.commons.lang

Class Preconditions

java.lang.Object

com.github.mjeanroy.junit.servers.commons.lang.Preconditions

public final class Preconditions
extends Object

Static utilities that can be used to check object's values.

Internal API: these methods are part of the internal API and may be removed, have their signature change, or have their access level decreased from public to protected, package, or private in future versions without notice.

Method Summary

Modifier and Type	Method and Description
static <T> Iterable<T>	doesNotContainNull(Iterable<T> values, String name) Check that given iterable does not contain any null values.
static String	notBlank(String value, String name) Check that a given string value is not blank (i.e not null, not empty and not blank).
static <T> Collection<T>	notEmpty(Collection<T> collection, String name) Check that given collection is not empty (i.e null or with a size equal to zero).
static <T> T	notNull(T value, String name) Check that a given value is not null.
static int	positive(int value, String name) Check that a given integer is positive.
static long	positive(long value, String name) Check that a given long value is positive.

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(T value,
                            String name)

Check that a given value is not null. It throws a NullPointerException exception if value is null or returned the value.

Type Parameters:

T - Type of value.

Parameters:

value - Value to check.

name - Name of parameter, it will produce an error message such as "{name} must not be null"

Returns:

First parameter if it is not null.

Throws:

NullPointerException - If value is null.

doesNotContainNull

public static <T> Iterable<T> doesNotContainNull(Iterable<T> values,
                                                 String name)

Check that given iterable does not contain any null values. It throws a NullPointerException exception if at least one value is null or returned the original iterable.

Type Parameters:

T - Type of value.

Parameters:

values - Values to check.

name - Name of parameter, it will produce an error message such as "{name[i]} must not be null"

Returns:

First parameter if it is not null.

Throws:

NullPointerException - If value is null.

notEmpty

public static <T> Collection<T> notEmpty(Collection<T> collection,
                                         String name)

Check that given collection is not empty (i.e null or with a size equal to zero). It throws a IllegalArgumentException exception if collection is empty or returned original collection otherwise. Generated message will be : {name} must not be empty Where name is the value given in parameter.

Type Parameters:

T - Type of elements.

Parameters:

collection - Collection.

name - Name of field to produce exception message.

Returns:

Original collection.

Throws:

NullPointerException - If collection is null.

IllegalArgumentException - If collection is empty.

notBlank

public static String notBlank(String value,
                              String name)

Check that a given string value is not blank (i.e not null, not empty and not blank). It throws a NullPointerException exception if value is null and throw an IllegalArgumentException if value is empty or blank. Otherwise original value is returned

Parameters:

value - Value to check.

name - Name of parameter, it will produce an error message such as "{name} must not be null" or "{name} must not be blank".

Returns:

First parameter if it is not blank.

positive

public static int positive(int value,
                           String name)

Check that a given integer is positive. If integer value is negative, it throws an IllegalArgumentException exception, otherwise integer value is returned.

Parameters:

value - Value to check.

name - Name of value.

Returns:

Integer value if value is positive.

positive

public static long positive(long value,
                            String name)

Check that a given long value is positive. If long value is negative, it throws an IllegalArgumentException exception, otherwise integer value is returned.

Parameters:

value - Value to check.

name - Name of value.

Returns:

Long value if value is positive.