@Target(value=METHOD) @Retention(value=RUNTIME) public @interface StringLengthFieldValidator
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")
Modifier and Type | Optional Element and Description |
---|---|
String |
fieldName |
String |
key |
String |
maxLength
Integer property.
|
String |
maxLengthExpression |
String |
message |
String[] |
messageParams |
String |
minLength
Integer property.
|
String |
minLengthExpression |
boolean |
shortCircuit
If this is activated, the validator will be used as short-circuit.
|
boolean |
trim
Boolean property.
|
String |
trimExpression |
ValidatorType[] |
type |
public abstract boolean trim
public abstract String trimExpression
public abstract String minLength
public abstract String minLengthExpression
public abstract String maxLength
public abstract String maxLengthExpression
public abstract String message
public abstract String key
public abstract String[] messageParams
public abstract String fieldName
public abstract boolean shortCircuit
public abstract ValidatorType[] type
Copyright © 2000–2020 Apache Software Foundation. All rights reserved.