Package ch.frostnova.util.check

Class Check

java.lang.Object

ch.frostnova.util.check.Check

public final class Check
extends java.lang.Object

Check class for input validation. See package info Javadoc for details and usage.

Since:

03.09.2017.

Method Summary

Modifier and Type	Method	Description
static <T> T	optional(T value, java.lang.String parameterName, Verify<? super T>... verifiers)	Perform checks on an optional value.
static <T> T	required(T value, java.lang.String parameterName, Verify<? super T>... verifiers)	Perform checks on a required value (must not be null).

Methods inherited from class java.lang.Object

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

Method Detail

optional

@SafeVarargs
public static <T> T optional(T value,
                             java.lang.String parameterName,
                             Verify<? super T>... verifiers)

Perform checks on an optional value. If the value is null, it is accepted (as being optional); only when the value is present, the verifiers are called for further verification. If any of the validations fail (by throwing any exception), an IllegalArgumentException will be thrown, including the parameter name an error message.

Type Parameters:

T - value type

Parameters:

value - value to be checked

parameterName - parameter name of the value (will be included in the error message)

verifiers - optional verifiers which perform checks on the value (only called when the value is not null), and throw any Exception (will be converted to an IllegalArgumentException is the same message) when the validation fails.

Returns:

value that was passed.

required

@SafeVarargs
public static <T> T required(T value,
                             java.lang.String parameterName,
                             Verify<? super T>... verifiers)

Perform checks on a required value (must not be null). The verifiers are called for further verification, if the value is not already null. If any of the validations fail (by throwing any exception), an IllegalArgumentException will be thrown, including the parameter name an error message.

Type Parameters:

T - value type

Parameters:

value - value to be checked

parameterName - parameter name of the value (will be included in the error message)

verifiers - optional verifiers which perform checks on the value (only called when the value is not null), and throw any Exception (will be converted to an IllegalArgumentException is the same message) when the validation fails.

Returns:

value that was passed.