Fork me on GitHub
<< back to Core Developers Guide Edit on GitHub

StringLengthFieldValidator Annotation

This validator checks that a String field is of the right length. It assumes that the field is a String. If neither minLength nor maxLength is set, nothing will be done.

Usage

The annotation must be applied at method level.

Parameters

Parameter Required Default Notes
message yes   field error message
key no   i18n key from language specific properties file.
messageParams no   Additional params to be used to customize message - will be evaluated against the Value Stack
fieldName no    
shortCircuit no false If this validator should be used as shortCircuit.
type yes ValidatorType.FIELD Enum value from ValidatorType. Either FIELD or SIMPLE can be used here.
trim no true Boolean property. Determines whether the String is trimmed before performing the length check.
minLength no   Integer property. The minimum length the String must be.
minLengthExpression no   OGNL expression used to obtain the minimum length the String must be.
maxLength no   Integer property. The maximum length the String can be.
maxLengthExpression no   OGNL expression used to obtain the maximum length the String can be.

If neither minLength nor maxLength is set, nothing will be done.

Examples

 @StringLengthFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true, minLength = "5",  maxLength = "12")