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 1187 2006-11-13 09:05:32 +0100 (Mon, 13 Nov 2006) mrdon $

Author:

Rainer Hermanns

Required Element Summary

String

message The default error message for this validator.

Optional Element Summary

String	fieldName The optional fieldName for SIMPLE validator types.
String	key The message key to lookup for i18n.
String	maxLength Integer property.
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.

Element Detail

message

public abstract String message

The default error message for this validator.

trim

public abstract boolean trim

Boolean property. Determines whether the String is trimmed before performing the length check.

Default:

true

minLength

public abstract String minLength

Integer property. The minimum length the String must be.

Default:

""

maxLength

public abstract String maxLength

Integer property. The maximum length the String can be.

Default:

""

key

public abstract String key

The message key to lookup for i18n.

Default:

""

fieldName

public abstract 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:

FIELD