Package io.ultreia.java4all.validation.impl.field

Class SkipableFieldValidatorSupport<O,F>

java.lang.Object

io.ultreia.java4all.validation.impl.field.FieldValidatorSupport<O,F>

io.ultreia.java4all.validation.impl.field.SkipableFieldValidatorSupport<O,F>

All Implemented Interfaces:

FieldValidator<O,F>

Direct Known Subclasses:

ExistingFileFieldValidator, FieldExpressionValidator, RequiredFieldValidator, RequiredFileFieldValidator

public abstract class SkipableFieldValidatorSupport<O,F>
extends FieldValidatorSupport<O,F>

This validator offers a way to skip validation. *

* To use this new field validator support, just now implements the method * validateWhenNotSkip(Object, NuitonValidationContext, ValidationMessagesCollector). This method will be invoked only if the skip * parameter is evaluated to false. Created on 28/01/2024.

Since:

2.0.0

Author:

Tony Chemit - dev@tchemit.fr

Constructor Summary

Constructors

Constructor	Description
SkipableFieldValidatorSupport(String fieldName, Function<O,F> fieldFunction)
SkipableFieldValidatorSupport(String fieldName, Function<O,F> fieldFunction, String messageKey, MessageBuilder<O,? super NuitonValidationContext,? super FieldValidator<O,?>> messageBuilder, BiFunction<O,NuitonValidationContext,Boolean> skipFunction)
SkipableFieldValidatorSupport(String fieldName, Function<O,F> fieldFunction, BiFunction<O,NuitonValidationContext,Boolean> skipFunction)

Method Summary

Modifier and Type	Method	Description
protected boolean	evaluateSkipParameter(O object, NuitonValidationContext validationContext)	Evaluate the skip parameter value against the object to validate.
protected BiFunction<O,NuitonValidationContext,Boolean>	skipFunction()
void	validate(O object, NuitonValidationContext validationContext, ValidationMessagesCollector messagesCollector)
protected abstract void	validateWhenNotSkip(O object, NuitonValidationContext validationContext, ValidationMessagesCollector messagesCollector)	Method to be invoked when skip parameter was not evaluated to true.

Methods inherited from class io.ultreia.java4all.validation.impl.field.FieldValidatorSupport

fieldFunction, getField, getFieldName, getMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ultreia.java4all.validation.impl.field.FieldValidator

addMessage

Constructor Detail

SkipableFieldValidatorSupport

public SkipableFieldValidatorSupport(String fieldName,
                                     Function<O,F> fieldFunction)

SkipableFieldValidatorSupport

public SkipableFieldValidatorSupport(String fieldName,
                                     Function<O,F> fieldFunction,
                                     BiFunction<O,NuitonValidationContext,Boolean> skipFunction)

SkipableFieldValidatorSupport

public SkipableFieldValidatorSupport(String fieldName,
                                     Function<O,F> fieldFunction,
                                     String messageKey,
                                     MessageBuilder<O,? super NuitonValidationContext,? super FieldValidator<O,?>> messageBuilder,
                                     BiFunction<O,NuitonValidationContext,Boolean> skipFunction)

Method Detail

validateWhenNotSkip

protected abstract void validateWhenNotSkip(O object,
                                            NuitonValidationContext validationContext,
                                            ValidationMessagesCollector messagesCollector)

Method to be invoked when skip parameter was not evaluated to true.

Parameters:

object - the object to be validated.

validationContext - to get access to outside world

messagesCollector - to collect messages

validate

public void validate(O object,
                     NuitonValidationContext validationContext,
                     ValidationMessagesCollector messagesCollector)

Parameters:

object - object to validate

validationContext - to get access to outside world

messagesCollector - to collect messages

evaluateSkipParameter

protected boolean evaluateSkipParameter(O object,
                                        NuitonValidationContext validationContext)

Evaluate the skip parameter value against the object to validate.

This parameter can be an OGNL expression.

Parameters:

object - the object to validate

validationContext - validation context

Returns:

the evaluation of the skip parameter.

skipFunction

protected BiFunction<O,NuitonValidationContext,Boolean> skipFunction()