com.opensymphony.xwork.validator.annotations
Annotation Type StringRegexValidator

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface StringRegexValidator

StringRegexValidator checks that a given String field, if not empty, matches the configured regular expression.

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.
regex	yes	"."	String property. The Regular Expression for which to check a match.
caseSensitive	no	true	Whether the matching of alpha characters in the expression should be done case-sensitively.

Example code:

 
 @StringRegexValidator(message = "Default message", key = "i18n.key", shortCircuit = true, regex = "a regular expression", caseSensitive = true)
 
 

Version:

$Id: StringRegexValidator.java 939 2006-03-23 18:13:36 +0100 (Thu, 23 Mar 2006) rainerh $

Author:

Rainer Hermanns

Required Element Summary

String	message The default error message for this validator.
String	regex String property.

Optional Element Summary

boolean	caseSensitive Whether the matching of alpha characters in the expression should be done case-sensitively.
String	fieldName The optional fieldName for SIMPLE validator types.
String	key The message key to lookup for i18n.
boolean	shortCircuit If this is activated, the validator will be used as short-circuit.
ValidatorType	type The validation type for this field/method.

Element Detail

message

public abstract String message

The default error message for this validator.

regex

public abstract String regex

String property. The Regular ExpressionValidator for which to check a match.

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:

""

caseSensitive

public abstract boolean caseSensitive

Whether the matching of alpha characters in the expression should be done case-sensitively.

Default:

true

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