Fork me on GitHub
Edit on GitHub << back to Annotations

LocalDateRangeFieldValidator Annotation

Since Struts 7.5.0

This validator checks that a java.time.LocalDate field has a value within a specified range, both bounds inclusive. It is the annotation form of the localdate validator; use the DateRangeFieldValidator Annotation for a java.util.Date field.

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   ISO date (yyyy-MM-dd). The minimum the date must be.
minExpression no   OGNL expression used to obtain the minimum the date must be.
max no   ISO date (yyyy-MM-dd). The maximum date can be.
maxExpression no   OGNL expression used to obtain the maximum date can be.

If neither min nor max is set, nothing will be done. A min or max that is not an ISO date fails when the validators are built, not when a request is validated.

Examples

 @LocalDateRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "2005-01-01", max = "2005-12-31")
Follow @x