io.validly

Class PreCondition<T,FV extends ValidationEngine>

java.lang.Object

io.validly.PreCondition<T,FV>

Direct Known Subclasses:

PreConditionInteger, PreConditionString

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ValidationEngine<T,FV>	validationEngine

Method Summary

Modifier and Type	Method and Description
ValidationEngine<T,? extends ValidationEngine>	canBeNull() Set the null value to be considered as valid.
ValidationEngine<T,? extends ValidationEngine>	must(java.util.function.Predicate<T> predicate, java.lang.String message)
ValidationEngine<T,? extends ValidationEngine>	mustNotBeNull(java.lang.String message) Set the null value to be considered as a validation error.
ValidationEngine<T,? extends ValidationEngine>	mustNotBeNullWhen(boolean mustNotBeNull, java.lang.String message) Set the null value to be considered as a validation error if the provided boolean is true.
PreCondition<T,? extends ValidationEngine>	validateWhen(boolean validate) Ignores the whole validation rule if the given value is false.
ValidationEngine<T,? extends ValidationEngine>	when(boolean value, Then<T>... thenPredicates) Evaluate the provided Then predicate(s) if the given boolean value is true.

Methods inherited from class java.lang.Object

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

Field Detail

validationEngine

protected final ValidationEngine<T,FV extends ValidationEngine> validationEngine

Method Detail

mustNotBeNull

public ValidationEngine<T,? extends ValidationEngine> mustNotBeNull(java.lang.String message)

Set the null value to be considered as a validation error.

Parameters:

message - error message.

Returns:

validation engine

canBeNull

public ValidationEngine<T,? extends ValidationEngine> canBeNull()

Set the null value to be considered as valid. If the value is null the engine will not even evaluate other predicates.

Returns:

validation engine

mustNotBeNullWhen

public ValidationEngine<T,? extends ValidationEngine> mustNotBeNullWhen(boolean mustNotBeNull,
                                                                        java.lang.String message)

Set the null value to be considered as a validation error if the provided boolean is true.

Parameters:

mustNotBeNull - boolean to determine if null value should be invalid

message - error message

Returns:

validation engine

validateWhen

public PreCondition<T,? extends ValidationEngine> validateWhen(boolean validate)

Ignores the whole validation rule if the given value is false.

Parameters:

validate - false will ignore the validation

Returns:

validation engine

when

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

Evaluate the provided Then predicate(s) if the given boolean value is true. Note that using the when() -condition as the first step, all the predicates will be executed using ValidationEngine.mustFatally(java.util.function.Predicate<T>, java.lang.String) method.

Parameters:

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

thenPredicates - array of then predicates

Returns:

validation engine

must

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