de.alpharogroup.check

Class Check

java.lang.Object

de.alpharogroup.check.Check

All Implemented Interfaces:

Serializable

public class Check
extends Object
implements Serializable

The Class Check can validate arguments in a chained manner like a builder.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Check	get() Gets the single Check instance.
Check	isInRange(Double min, Double max, Double value, String name) Checks if the given argument is in the given a range.
Check	isInRange(Float min, Float max, Float value, String name) Checks if the given argument is in the given a range.
Check	isInRange(Integer min, Integer max, Integer value, String name) Checks if the given argument is in the given a range.
Check	isInRange(Long min, Long max, Long value, String name) Checks if the given argument is in the given a range.
<T,C extends Collection<T>> Check	notEmpty(C collection, String name) Checks if the given collection is not null or empty.
<T,K,V,M extends Map<K,V>> Check	notEmpty(M map, String name) Checks if the given map is not null or empty.
<T extends CharSequence> Check	notEmpty(T argument, String name) Checks if the given argument is not empty.
<T> Check	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

Method Detail

get

public static Check get()

Gets the single Check instance.

Returns:

the single Check instance.

notNull

public <T> Check 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 a reference to this object. This case is if the given argument is not null.

Throws:

IllegalArgumentException - when the given argument is null.

notEmpty

public <T extends CharSequence> Check 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 a reference to this object. This case is if the given argument is not null or empty.

Throws:

IllegalArgumentException - when the given argument is null or empty.

notEmpty

public <T,C extends Collection<T>> Check 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 a reference to this 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 <T,K,V,M extends Map<K,V>> Check notEmpty(M map,
                                                 String name)

Checks if the given map is not null or empty.

Type Parameters:

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

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 a reference to this object. This case is if the given map is not null or empty.

Throws:

IllegalArgumentException - when the given map is null or empty.

isInRange

public Check isInRange(Integer min,
                       Integer max,
                       Integer value,
                       String name)

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

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 a reference to this object. This case is if the given argument is in the given range.

Throws:

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

isInRange

public Check isInRange(Long min,
                       Long max,
                       Long value,
                       String name)

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

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 a reference to this object. This case is if the given argument is in the given range.

Throws:

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

isInRange

public Check isInRange(Float min,
                       Float max,
                       Float value,
                       String name)

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

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 a reference to this object. This case is if the given argument is in the given range.

Throws:

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

isInRange

public Check isInRange(Double min,
                       Double max,
                       Double value,
                       String name)

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

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 a reference to this object. This case is if the given argument is in the given range.

Throws:

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