com.opensymphony.xwork2.validator.annotations
Annotation Type StringLengthFieldValidator


@Target(value=METHOD)
@Retention(value=RUNTIME)
public @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.
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.
maxLength no   Integer property. 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")
 
 

Version:
$Id: StringLengthFieldValidator.java 894090 2009-12-27 18:18:29Z martinc $
Author:
Rainer Hermanns

Optional Element Summary
 java.lang.String fieldName
          The optional fieldName for SIMPLE validator types.
 java.lang.String key
          The message key to lookup for i18n.
 java.lang.String maxLength
          Integer property.
 java.lang.String message
          The default error message for this validator.
 java.lang.String minLength
          Integer property.
 boolean shortCircuit
          If this is activated, the validator will be used as short-circuit.
 boolean trim
          Boolean property.
 ValidatorType[] type
          The validation type for this field/method.
 

trim

public abstract boolean trim
Boolean property. Determines whether the String is trimmed before performing the length check.

Default:
true

minLength

public abstract java.lang.String minLength
Integer property. The minimum length the String must be.

Default:
""

maxLength

public abstract java.lang.String maxLength
Integer property. The maximum length the String can be.

Default:
""

message

public abstract java.lang.String message
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

public abstract java.lang.String key
The message key to lookup for i18n.

Default:
""

fieldName

public abstract java.lang.String fieldName
The optional fieldName for SIMPLE validator types.

Default:
""

shortCircuit

public abstract boolean shortCircuit
If this is activated, the validator will be used as short-circuit. Adds the short-circuit="true" attribute value if true.

Default:
false

type

public abstract ValidatorType[] type
The validation type for this field/method.

Default:
com.opensymphony.xwork2.validator.annotations.ValidatorType.FIELD


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.