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

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

This validator checks that a double field has a value within a specified range. If neither min nor max 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.
minInclusive	no		Double property. The inclusive minimum the number must be.
maxInclusive	no		Double property. The inclusive maximum number can be.
minExclusive	no		Double property. The exclusive minimum the number must be.
maxExclusive	no		Double property. The exclusive maximum number can be.

If neither min nor max is set, nothing will be done.

The values for min and max must be inserted as String values so that "0" can be handled as a possible value.

Example code:

 
 @DoubleRangeFieldValidator(message = "Default message", key = "i18n.key", shortCircuit = true, minInclusive = "0.123", maxInclusive = "99.987")
 
 

Version:

$Id: DoubleRangeFieldValidator.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	maxExclusive Double property.
String	maxInclusive Double property.
String	minExclusive Double property.
String	minInclusive Double property.
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.

minInclusive

public abstract String minInclusive

Double property. The inclusive minimum the number must be.

Default:

""

maxInclusive

public abstract String maxInclusive

Double property. The inclusive minimum the number must be.

Default:

""

minExclusive

public abstract String minExclusive

Double property. The exclusive maximum number can be.

Default:

""

maxExclusive

public abstract String maxExclusive

Double property. The exclusive maximum number 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