io.validly

Class ValidationEngine<T,FV extends ValidationEngine>

java.lang.Object

io.validly.ValidationEngine<T,FV>

Direct Known Subclasses:

ValidationEngineInteger, ValidationEngineString

public class ValidationEngine<T,FV extends ValidationEngine>
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValidationEngine(java.lang.String fieldName, T value, ValidlyNote note)
protected	ValidationEngine(T value)
protected	ValidationEngine(T value, java.util.List<java.lang.String> note)

Method Summary

Modifier and Type	Method and Description
ValidationEngine<T,FV>	must(java.util.function.Predicate<T> predicate, java.lang.String message) Set the value for which the predicate test returns false to be considered as invalid.
<NEW_TYPE> ValidationEngine<NEW_TYPE,ValidationEngine>	mustConvert(java.util.function.Function<T,NEW_TYPE> conversionFunction, java.lang.String message) Applies the given function with the value.
ValidationEngine<T,FV>	mustFatally(java.util.function.Predicate<T> predicate, java.lang.String message) Same as method must(java.util.function.Predicate<T>, java.lang.String) but the remaining validation predicates defined for this value will not be evaluated if the predicate test returns false (Note-All Mode).
protected void	setFailOnFirst(boolean failOnFirst)
protected void	setStopValidation(boolean stopValidation)
ValidationEngine<T,FV>	when(boolean value, Then<T>... thenPredicates) Evaluate the provided Then predicate(s) if the given boolean value is true.
ValidationEngine<T,FV>	when(java.util.function.Predicate<T> predicate, Then<T>... thenPredicates) Evaluate the provided Then predicate(s) if the first predicate is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationEngine

protected ValidationEngine(java.lang.String fieldName,
                           T value,
                           ValidlyNote note)

ValidationEngine

protected ValidationEngine(T value,
                           java.util.List<java.lang.String> note)

ValidationEngine

protected ValidationEngine(T value)

Method Detail

must

public ValidationEngine<T,FV> must(java.util.function.Predicate<T> predicate,
                                   java.lang.String message)

Set the value for which the predicate test returns false to be considered as invalid.

Parameters:

predicate - predicate the evaluate

message - validation error

Returns:

validation engine

mustFatally

public ValidationEngine<T,FV> mustFatally(java.util.function.Predicate<T> predicate,
                                          java.lang.String message)

Same as method must(java.util.function.Predicate<T>, java.lang.String) but the remaining validation predicates defined for this value will not be evaluated if the predicate test returns false (Note-All Mode).

E.g.
value(name, note)
.mustNotBeNull("")
.mustFatally(s -> s.equals("something"), "") -- if this fails
.must(s -> s.startsWith("so"), "") -- this won't be evaluated

Parameters:

predicate - predicate to evaluate

message - validation error

Returns:

validation engine

mustConvert

public <NEW_TYPE> ValidationEngine<NEW_TYPE,ValidationEngine> mustConvert(java.util.function.Function<T,NEW_TYPE> conversionFunction,
                                                                          java.lang.String message)

Applies the given function with the value. This allows values to be converted into a different types during the validation. If the provided function returns null or throws an exception the value will be considered as invalid and no further predicates will be evaluated (Note-All Mode).

valid(date, "date", note)
.mustNotBeNull("must not be null")
.mustConvert(s -> LocalDate.parse(s, ofPattern("dd.MM.yyyy")), "invalid date")
.must(d -> d.isAfter(LocalDate.now()), "date must be in the future");

Type Parameters:

NEW_TYPE - return type of the function

Parameters:

conversionFunction - function the is applied with the value as input

message - validation error

Returns:

validation engine typed as NEW_TYPE

when

@SafeVarargs
public final ValidationEngine<T,FV> when(java.util.function.Predicate<T> predicate,
                                                      Then<T>... thenPredicates)

Evaluate the provided Then predicate(s) if the first predicate is true.

Parameters:

predicate - determines whether to evaluate the then predicate(s)

thenPredicates - array of then predicates

Returns:

validation engine

when

@SafeVarargs
public final ValidationEngine<T,FV> when(boolean value,
                                                      Then<T>... thenPredicates)

Evaluate the provided Then predicate(s) if the given boolean value is true.

Parameters:

value - determines whether to evaluate the then predicate(s)

thenPredicates - array of then predicates

Returns:

validation engine

setFailOnFirst

protected void setFailOnFirst(boolean failOnFirst)

setStopValidation

protected void setStopValidation(boolean stopValidation)