Annotation Interface DateRangeFieldValidator
This validator checks that a date field has a value within a specified range.
Annotation usage:
The annotation must be applied at method level.
Annotation 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 | Date property. The minimum the date must be. | |
| minExpression | no | OGNL expression used to obtain the minimum the date must be. | |
| max | no | Date property. The maximum date can be. | |
| maxExpression | no | OGNL expression used to obtain the maximum date can be. | |
| maxExpression | no | OGNL expression used to obtain the maximum date can be. | |
| dateFormat | no | Format used to parse min/max value. |
If neither min nor max is set, nothing will be done.
Example code:
@DateRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, min = "2005/01/01", max = "2005/12/31")
- Author:
- Rainer Hermanns
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionDate property.String[]Date property.booleanIf this is activated, the validator will be used as short-circuit.
-
Element Details
-
min
String minDate property.- Returns:
- The minimum the date must be.
- Default:
- ""
-
minExpression
String minExpression- Returns:
- An expression which will be evaluated against the Value Stack to get the min value
- Default:
- ""
-
max
String maxDate property.- Returns:
- The maximum date can be.
- Default:
- ""
-
maxExpression
String maxExpression- Returns:
- An expression which will be evaluated against the Value Stack to get the max value
- Default:
- ""
-
dateFormat
String dateFormat- Returns:
- Date format used to parse min and max value
- Default:
- ""
-
message
String message- Returns:
- The default error message for this validator. NOTE: It is required to set a message, if you are not using the message key for 18n lookup!
- Default:
- ""
-
key
String key- Returns:
- The message key to lookup for i18n.
- Default:
- ""
-
messageParams
String[] messageParams- Returns:
- Additional params to be used to customize message - will be evaluated against the Value Stack
- Default:
- {}
-
fieldName
String fieldName- Returns:
- The optional fieldName for SIMPLE validator types.
- Default:
- ""
-
shortCircuit
boolean shortCircuitIf this is activated, the validator will be used as short-circuit. Adds the short-circuit="true" attribute value if true.- Returns:
- true if validator will be used as short-circuit. Default is false.
- Default:
- false
-
type
ValidatorType type- Returns:
- The validation type for this field/method.
- Default:
- FIELD
-