fluent.validation

Class Check<T>

java.lang.Object

fluent.validation.Check<T>

Type Parameters:

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

Direct Known Subclasses:

CheckDsl, Statement

public abstract class Check<T>
extends Object

Simple check used in for validation of various data. It implements the Java 8 Predicate, providing simple #test(V value) method, which simply tests, if value meets a condition (pretty the same). But the main purpose of this class is to provide transparency during any complex condition 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.
String	name() Name of the check.
<U extends T> Check<U>	or(Check<? super U> operand) Compose this check with another one using logical OR operator.
static <T> boolean	test(T data, Check<? super T> check)
static <T> boolean	test(T data, Check<? super T> check, CheckVisitor checkVisitor)
protected abstract boolean	test(T data, CheckVisitor checkVisitor) Evaluation of the condition on provided data, able to provide full detail of the evaluation using provided detail collector.
static <T> void	that(T data, Check<? super T> check)
static <T> void	that(T data, Check<? super T> check, CheckVisitor logger)
protected static boolean	trace(CheckVisitor node, Object actualValue, boolean result) Shortcut method, that traces current node detail, and returns result.
protected static boolean	trace(CheckVisitor checkVisitor, String expectation, Object actualValue, boolean result) Shortcut method, that traces current leaf detail, and returns result.

Methods inherited from class java.lang.Object

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

Constructor Detail

Check

public Check()

Method Detail

test

protected abstract boolean test(T data,
                                CheckVisitor checkVisitor)

Evaluation of the condition on provided data, able to provide full detail of the evaluation using provided detail collector.

Parameters:

data - Data to test by the condition.

checkVisitor - Tracer of the evaluation detail.

Returns:

Evaluation result.

name

public String name()

Name of the check.

Returns:

The name.

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.

test

public static <T> boolean test(T data,
                               Check<? super T> check)

test

public static <T> boolean test(T data,
                               Check<? super T> check,
                               CheckVisitor checkVisitor)

that

public static <T> void that(T data,
                            Check<? super T> check)

that

public static <T> void that(T data,
                            Check<? super T> check,
                            CheckVisitor logger)

trace

protected static boolean trace(CheckVisitor node,
                               Object actualValue,
                               boolean result)

Shortcut method, that traces current node detail, and returns result.

Parameters:

node - Tracer node wrapping composed condition details.

actualValue - Actual value.

result - Result of the composed condition.

Returns:

Result of the composed condition.

trace

protected static boolean trace(CheckVisitor checkVisitor,
                               String expectation,
                               Object actualValue,
                               boolean result)

Shortcut method, that traces current leaf detail, and returns result.

Parameters:

checkVisitor - Tracer for tracing condition details.

expectation - Description of the expectation.

actualValue - Actual value.

result - Result of the condition.

Returns:

Result of the condition.