org.spincast.core.validation

Interface ValidationBuilderCoreBase<T extends ValidationBuilderCoreBase<?>>

All Known Subinterfaces:

ValidationBuilderArray, ValidationBuilderCore

All Known Implementing Classes:

ValidationBuilderArrayDefault, ValidationBuilderCoreDefault

public interface ValidationBuilderCoreBase<T extends ValidationBuilderCoreBase<?>>

The core of the builder used to create a Validation Set.

Method Summary

Modifier and Type	Method and Description
T	addMessageOnSuccess() If the validation is successful, the validator should add a Success Message.
T	addMessageOnSuccess(String customSuccessMessageText) If the validation is successful, the validator should add a Success Message.
T	code(String code) Modifies the default validation code.
T	failMessageText(String customFailMessageText) Instead of the default one, use the specified text for the validation Message in case of a failure.
T	treatErrorAsWarning() If this is called, a validation failure will result in a Warning level Message instead of an Error level Message.
ValidationSet	validate() Performs the validation, saves the result into the validation set and returns it.
ValidationSet	validate(boolean onlyIfNoMessageYet) Performs the validation, saves the result into the validation set and returns it.
ValidationSet	validate(ValidationLevel onlyIfNoMessageAtThisLevelOrHigherYet) Performs the validation, saves the result into the validation set and returns it.

Method Detail

code

T code(String code)

Modifies the default validation code.

addMessageOnSuccess

T addMessageOnSuccess()

If the validation is successful, the validator should add a Success Message. The default behavior is to only add Error and Warning Messages.

addMessageOnSuccess

T addMessageOnSuccess(String customSuccessMessageText)

If the validation is successful, the validator should add a Success Message. The default behavior is to only add Error and Warning Messages.

Parameters:

customSuccessMessageText - The text to use for the Message instead of the default one.

treatErrorAsWarning

T treatErrorAsWarning()

If this is called, a validation failure will result in a Warning level Message instead of an Error level Message. This can be useful to indicate to a user that some data is valid, but with a warning...

Please remember that an object with Warnings validation messages and no Error Messages is considered as valid!

failMessageText

T failMessageText(String customFailMessageText)

Instead of the default one, use the specified text for the validation Message in case of a failure.

Note that this text will be used for Errors but also for Warning Message text is treatErrorAsWarning() has been called.

validate

ValidationSet validate()

Performs the validation, saves the result into the validation set and returns it.

validate

ValidationSet validate(boolean onlyIfNoMessageYet)

Performs the validation, saves the result into the validation set and returns it.

Parameters:

onlyIfNoMessageYet - if true, the validation will be performs only if no Message already exists for the validation key. This is a synonym to calling validate(ValidationLevel.SUCCESS).

validate

ValidationSet validate(ValidationLevel onlyIfNoMessageAtThisLevelOrHigherYet)

Performs the validation, saves the result into the validation set and returns it.

Parameters:

onlyIfNoMessageYet - The validation will be performs only if no Message at the specified ValidationLevel or higher already exists for the validation key.

• validate(ValidationLevel.SUCCESS) : The validation will be perform only if no messages at all already exist for that validation key.
• validate(ValidationLevel.WARNING) : The validation will be perform only if no WARNING or ERROR messages already exist for that validation key.
• validate(ValidationLevel.ERROR) : The validation will be perform only if no ERROR messages already exist for that validation key.