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


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

This non-field level validator validates a supplied 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.
shortCircuit no false If this validator should be used as shortCircuit.
expression yes   An OGNL expression that returns a boolean value.

Example code:

 
 @ExpressionValidator(message = "Default message", key = "i18n.key", shortCircuit = true, expression = "an OGNL expression" )
 
 

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

Required Element Summary
 java.lang.String expression
          The expressions to validate.
 
Optional Element Summary
 java.lang.String key
          The message key to lookup for i18n.
 java.lang.String message
          The default error message for this validator.
 boolean shortCircuit
          If this is activated, the validator will be used as short-circuit.
 

Element Detail

expression

public abstract java.lang.String expression
The expressions to validate. An OGNL expression that returns a boolean value.

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:
""

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


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