fluent.validation

Class Check<T>

java.lang.Object

fluent.validation.Check<T>

Type Parameters:

T - Type of the data to be tested using this check.

Direct Known Subclasses:

AbstractCheckDsl, MapCheckBuilder

public abstract class Check<T>
extends Object

Simple check used in for validation of various data. It tests, if value meets a criteria described by the check. But the main purpose of this class is to provide transparency during any complex check evaluation, similar to Hamcrest Matchers. If you are familiar with Hamcrest matchers, it should be easy to get familiar with Checks too. There are only following differences: 1. Evaluation detail is not limited to mismatch description. You can achieve full detail even for passed ones. 2. This interface is type-safe on application (see test() methods are accepting class type argument, not Object). It may be limiting, but helps avoid test errors. 3. Thanks to it being generic, it's very simple to simplify creation of any custom, or composed conditions with advantage of Java 8 functional interfaces (lambdas).

Constructor Summary

Constructors

Constructor and Description
Check()

Method Summary

Modifier and Type	Method and Description
<U extends T> Check<U>	and(Check<? super U> operand) Compose this check with another one using logical AND operator.
static <T> Result	evaluate(T data, Check<? super T> check)
static <T> Result	evaluate(T data, Check<? super T> check, ResultFactory resultFactory)
protected abstract Result	evaluate(T data, ResultFactory factory) Abstract method to delegate implementation of specific check logic to subclasses.
<U extends T> Check<U>	or(Check<? super U> operand) Compose this check with another one using logical OR operator.
static <T> boolean	that(T data, Check<? super T> check) Assert the data using provided check.
static <T> boolean	that(T data, Check<? super T> check, ResultFactory resultFactory) Assert the data using provided check.
abstract String	toString() Enforce to implement toString() in every subclass.

Methods inherited from class java.lang.Object

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

Constructor Detail

Check

public Check()

Method Detail

evaluate

protected abstract Result evaluate(T data,
                                   ResultFactory factory)

Abstract method to delegate implementation of specific check logic to subclasses.

Parameters:

data - Tested data.

Returns:

representation of outcome of the test.

toString

public abstract String toString()

Enforce to implement toString() in every subclass.

Overrides:

toString in class Object

Returns:

String representation of the check.

and

public <U extends T> Check<U> and(Check<? super U> operand)

Compose this check with another one using logical AND operator.

Type Parameters:

U - Type of the data tested by other check. It may cause up-cast.

Parameters:

operand - Another check.

Returns:

Composed check.

or

public <U extends T> Check<U> or(Check<? super U> operand)

Compose this check with another one using logical OR operator.

Type Parameters:

U - Type of the data tested by other check. It may cause up-cast.

Parameters:

operand - Another check.

Returns:

Composed check.

that

@End(message="Check is not used. Pass it either to Assert.that(), Check.that() or Check.evaluate().")
public static <T> boolean that(T data,
                                                                                                                                     Check<? super T> check)

Assert the data using provided check.

Type Parameters:

T - Type of the tested data.

Parameters:

data - Tested data.

check - Check to be applied.

that

@End(message="Check is not used. Pass it either to Assert.that(), Check.that() or Check.evaluate().")
public static <T> boolean that(T data,
                                                                                                                                     Check<? super T> check,
                                                                                                                                     ResultFactory resultFactory)

Assert the data using provided check.

Type Parameters:

T - Type of the tested data.

Parameters:

data - Tested data.

check - Check to be applied.

evaluate

public static <T> Result evaluate(T data,
                                  Check<? super T> check)

evaluate

public static <T> Result evaluate(T data,
                                  Check<? super T> check,
                                  ResultFactory resultFactory)