Annotation Interface StringLengthFieldValidator
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.
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. |
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.
Example code:
@StringLengthFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, trim = true, minLength = "5", maxLength = "12")
- Author:
- Rainer Hermanns
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionInteger property.String[]
Integer property.boolean
If this is activated, the validator will be used as short-circuit.boolean
Boolean property.
-
Element Details
-
trim
boolean trimBoolean property.- Returns:
- Determines whether the String is trimmed before performing the length check.
- Default:
- true
-
trimExpression
String trimExpression- Returns:
- Determines whether the String is trimmed before performing the length check but defined as an expression
- Default:
- ""
-
minLength
String minLengthInteger property.- Returns:
- The minimum length the String must be.
- Default:
- ""
-
minLengthExpression
String minLengthExpression- Returns:
- The minimum length the String must be defined as an expression
- Default:
- ""
-
maxLength
String maxLengthInteger property.- Returns:
- The maximum length the String can be.
- Default:
- ""
-
maxLengthExpression
String maxLengthExpression- Returns:
- The maximum length the String can be defined as an expression
- 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}
-