Module de.mlo.dev.validation

Package de.mlo.dev.validation

Interface ValidationStatement

All Superinterfaces:

ValidationSummarizer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ValidationStatement
extends ValidationSummarizer

A ValidationStatement is the smallest part of a validation Process.

Author:

mlo

Method Summary

Modifier and Type	Method	Description
@NotNull ValidationInfo	execute()	The implementation must contain any validation logic.
default @NotNull ValidationResult	validate()	Wraps the result of execute() in a ValidationResult Has to execute one or more parts of the validation process.

Method Detail

execute

@NotNull
@NotNull ValidationInfo execute()

The implementation must contain any validation logic. If the validation fails return a ValidationInfo with a message, which describes the error. Use the ValidationInfo.invalid(String) function in this case.
If the validation was successful you can use the ValidationInfo.valid() function. This creates an information object with no message (usually the message is not important if the validation succeed, but it may help with debugging).
Example:

 public ValidationInfo validate(){
     String name = unbindName();
     if (name.isBlank()){
         return ValidationInfo.invalid("Name is blank");
     }
     return ValidationInfo.valid();
 }
 

Statements can be grouped and chained by using a Validator

Returns:

The information if the validation succeed or not. Check the ValidationInfo.getMessage() if the validation failed. Returning null will result in a NullPointerException

validate

@NotNull
default @NotNull ValidationResult validate()

Wraps the result of execute() in a ValidationResult Has to execute one or more parts of the validation process. The result of all executed parts should be returned as an aggregated ValidationResult.

Specified by:

validate in interface ValidationSummarizer

Returns:

A wrapped ValidationInfo. The result contains exactly one info