de.alpharogroup.check

Class Argument

java.lang.Object

de.alpharogroup.check.Argument

public class Argument
extends Object

The class Argument that can assert conditions on arguments.

Constructor Summary

Constructors

Constructor and Description
Argument()

Method Summary

Modifier and Type	Method and Description
static <T extends Comparable<? super T>> T	isInRange(T min, T max, T value, String name) Checks if the given value argument is in the given a range.
static <T,C extends Collection<T>> C	notEmpty(C collection, String name) Checks if the given collection is not null or empty.
static <K,V,M extends Map<K,V>> M	notEmpty(M map, String name) Checks if the given map is not null or empty.
static <T extends CharSequence> T	notEmpty(T argument, String name) Checks if the given argument is not empty.
static <T> T	notNull(T argument, String name) Checks if the given argument is not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

Argument

public Argument()

Method Detail

isInRange

public static <T extends Comparable<? super T>> T isInRange(T min,
                                                            T max,
                                                            T value,
                                                            String name)

Checks if the given value argument is in the given a range.

Type Parameters:

T - the generic type of the arguments

Parameters:

min - The minimum from the range to check.

max - The maximum from the range to check.

value - The value to check if it is in the given range.

name - the name of the given argument

Returns:

if the check is successful the value object. This case is if the given value is in the given range.

Throws:

IllegalArgumentException - when the given value is not in the given range.

notEmpty

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

Checks if the given collection is not null or empty.

Type Parameters:

T - the generic type of the elements in the given collection

C - the generic type of the given collection

Parameters:

collection - the collection to check

name - the name of the given collection

Returns:

if the check is successful the collection object. This case is if the given collection is not null or empty.

Throws:

IllegalArgumentException - when the given collection is null or empty.

notEmpty

public static <K,V,M extends Map<K,V>> M notEmpty(M map,
                                                  String name)

Checks if the given map is not null or empty.

Type Parameters:

K - the generic type of the key from the given Map

V - the generic type of the value from the given Map

M - the generic type of the given Map

Parameters:

map - the map to check

name - the name of the given collection

Returns:

if the check is successful the map object. This case is if the given map is not null or empty.

Throws:

IllegalArgumentException - when the given map is null or empty.

notEmpty

public static <T extends CharSequence> T notEmpty(T argument,
                                                  String name)

Checks if the given argument is not empty.

Type Parameters:

T - the generic type of the given argument

Parameters:

argument - the argument

name - the name of the given argument

Returns:

if the check is successful the argument object. This case is if the given argument is not null or empty.

Throws:

IllegalArgumentException - when the given argument is null or empty.

notNull

public static <T> T notNull(T argument,
                            String name)

Checks if the given argument is not null.

Type Parameters:

T - the generic type of the given argument

Parameters:

argument - the argument

name - the name of the given argument

Returns:

if the check is successful the argument object. This case is if the given argument is not null.

Throws:

IllegalArgumentException - when the given argument is null.