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

IntRangeFieldValidator Annotation

This validator checks that a numeric field has a value within a specified range. If neither min nor max 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.
min no   Integer property. The minimum the number must be.
minExpression no   OGNL expression used to obtain the minimum the number must be.
max no   Integer property. The maximum number can be. Can be an expression.!
maxExpression no   OGNL expression used to obtain the maximum number can be.
parse no false Enable parsing of min/max value.

If neither min nor max is set, nothing will be done.

The values for min and max must be inserted as String values so that "0" can be handled as a possible value.

Examples

 @IntRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "0", max = "42")

 @IntRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, minExpression = "${minValue}", maxExpression = "${maxValue}")