org.springmodules.validation.commons
Class FieldChecks

java.lang.Object
  org.springmodules.validation.commons.FieldChecks

All Implemented Interfaces:

Serializable

public class FieldChecks
extends Object
implements Serializable

This class contains the default validations that are used in the validator-rules.xml file.

In general passing in a null or blank will return a null Object or a false boolean. However, nulls and blanks do not result in an error being added to the Errors.

Author:

David Winterfeldt, James Turner, Rob Leland, Daniel Miller, Rob Harrop

See Also:

Serialized Form

Field Summary

static String	FIELD_TEST_EQUAL
static String	FIELD_TEST_NOTNULL
static String	FIELD_TEST_NULL

Constructor Summary

FieldChecks()

Method Summary

protected static String	extractValue(Object bean, org.apache.commons.validator.Field field) Extracts the value of the given bean.
static void	rejectValue(Errors errors, org.apache.commons.validator.Field field, org.apache.commons.validator.ValidatorAction va) Convinience method to perform the work of rejecting a field's value.
static Byte	validateByte(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field can safely be converted to a byte primitive.
static Long	validateCreditCard(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field is a valid credit card number.
static Date	validateDate(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field is a valid date.
static Double	validateDouble(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field can safely be converted to a double primitive.
static boolean	validateDoubleRange(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if a fields value is within a range (min & max specified in the vars attribute).
static boolean	validateEmail(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if a field has a valid e-mail address.
static Float	validateFloat(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field can safely be converted to a float primitive.
static boolean	validateFloatRange(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if a fields value is within a range (min & max specified in the vars attribute).
static Integer	validateInteger(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field can safely be converted to an int primitive.
static boolean	validateIntRange(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if a fields value is within a range (min & max specified in the vars attribute).
static Long	validateLong(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field can safely be converted to a long primitive.
static boolean	validateMask(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field matches the regular expression in the field's mask attribute.
static boolean	validateMaxLength(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field's length is less than or equal to the maximum value.
static boolean	validateMinLength(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field's length is greater than or equal to the minimum value.
static boolean	validateRange(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Deprecated. As of Struts 1.1, replaced by #validateIntRange(java.lang.Object, org.apache.validator.validator.ValidatorAction, org.apache.validator.validator.Field, org.apache.struts.action.Errors, javax.servlet.http.HttpServletRequest)
static boolean	validateRequired(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field isn't null and length of the field is greater than zero not including whitespace.
static boolean	validateRequiredIf(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors, org.apache.commons.validator.Validator validator) Checks if the field isn't null based on the values of other fields.
static Short	validateShort(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors) Checks if the field can safely be converted to a short primitive.
static boolean	validateValidWhen(Object bean, org.apache.commons.validator.ValidatorAction va, org.apache.commons.validator.Field field, Errors errors, org.apache.commons.validator.Validator validator) Checks if the field matches the boolean expression specified in test parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_TEST_NULL

public static final String FIELD_TEST_NULL

See Also:

Constant Field Values

FIELD_TEST_NOTNULL

public static final String FIELD_TEST_NOTNULL

See Also:

Constant Field Values

FIELD_TEST_EQUAL

public static final String FIELD_TEST_EQUAL

See Also:

Constant Field Values

Constructor Detail

FieldChecks

public FieldChecks()

Method Detail

validateRequired

public static boolean validateRequired(Object bean,
                                       org.apache.commons.validator.ValidatorAction va,
                                       org.apache.commons.validator.Field field,
                                       Errors errors)

Checks if the field isn't null and length of the field is greater than zero not including whitespace.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur.

Returns:

true if meets stated requirements, false otherwise.

validateRequiredIf

public static boolean validateRequiredIf(Object bean,
                                         org.apache.commons.validator.ValidatorAction va,
                                         org.apache.commons.validator.Field field,
                                         Errors errors,
                                         org.apache.commons.validator.Validator validator)

Checks if the field isn't null based on the values of other fields.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur.

validator - The Validator instance, used to access other field values. -param request Current request object.

Returns:

true if meets stated requirements, false otherwise.

validateMask

public static boolean validateMask(Object bean,
                                   org.apache.commons.validator.ValidatorAction va,
                                   org.apache.commons.validator.Field field,
                                   Errors errors)

Checks if the field matches the regular expression in the field's mask attribute.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

true if field matches mask, false otherwise.

validateByte

public static Byte validateByte(Object bean,
                                org.apache.commons.validator.ValidatorAction va,
                                org.apache.commons.validator.Field field,
                                Errors errors)

Checks if the field can safely be converted to a byte primitive.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

A Byte if valid, null otherwise.

validateShort

public static Short validateShort(Object bean,
                                  org.apache.commons.validator.ValidatorAction va,
                                  org.apache.commons.validator.Field field,
                                  Errors errors)

Checks if the field can safely be converted to a short primitive.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

A Short if valid, otherwise null.

validateInteger

public static Integer validateInteger(Object bean,
                                      org.apache.commons.validator.ValidatorAction va,
                                      org.apache.commons.validator.Field field,
                                      Errors errors)

Checks if the field can safely be converted to an int primitive.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

An Integer if valid, a null otherwise.

validateLong

public static Long validateLong(Object bean,
                                org.apache.commons.validator.ValidatorAction va,
                                org.apache.commons.validator.Field field,
                                Errors errors)

Checks if the field can safely be converted to a long primitive.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

A Long if valid, a null otherwise.

validateFloat

public static Float validateFloat(Object bean,
                                  org.apache.commons.validator.ValidatorAction va,
                                  org.apache.commons.validator.Field field,
                                  Errors errors)

Checks if the field can safely be converted to a float primitive.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

A Float if valid, a null otherwise.

validateDouble

public static Double validateDouble(Object bean,
                                    org.apache.commons.validator.ValidatorAction va,
                                    org.apache.commons.validator.Field field,
                                    Errors errors)

Checks if the field can safely be converted to a double primitive.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

A Double if valid, a null otherwise.

validateDate

public static Date validateDate(Object bean,
                                org.apache.commons.validator.ValidatorAction va,
                                org.apache.commons.validator.Field field,
                                Errors errors)

Checks if the field is a valid date. If the field has a datePattern variable, that will be used to format java.text.SimpleDateFormat. If the field has a datePatternStrict variable, that will be used to format java.text.SimpleDateFormat and the length will be checked so '2/12/1999' will not pass validation with the format 'MM/dd/yyyy' because the month isn't two digits. If no datePattern variable is specified, then the field gets the DateFormat.SHORT format for the locale. The setLenient method is set to false for all variations.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

A Date if valid, a null if blank or invalid.

validateRange

public static boolean validateRange(Object bean,
                                    org.apache.commons.validator.ValidatorAction va,
                                    org.apache.commons.validator.Field field,
                                    Errors errors)

Deprecated. As of Struts 1.1, replaced by #validateIntRange(java.lang.Object, org.apache.validator.validator.ValidatorAction, org.apache.validator.validator.Field, org.apache.struts.action.Errors, javax.servlet.http.HttpServletRequest)

Checks if a fields value is within a range (min & max specified in the vars attribute).

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

True if in range, false otherwise.

validateIntRange

public static boolean validateIntRange(Object bean,
                                       org.apache.commons.validator.ValidatorAction va,
                                       org.apache.commons.validator.Field field,
                                       Errors errors)

Checks if a fields value is within a range (min & max specified in the vars attribute).

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur.

Returns:

true if in range, false otherwise.

validateDoubleRange

public static boolean validateDoubleRange(Object bean,
                                          org.apache.commons.validator.ValidatorAction va,
                                          org.apache.commons.validator.Field field,
                                          Errors errors)

Checks if a fields value is within a range (min & max specified in the vars attribute).

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

True if in range, false otherwise.

validateFloatRange

public static boolean validateFloatRange(Object bean,
                                         org.apache.commons.validator.ValidatorAction va,
                                         org.apache.commons.validator.Field field,
                                         Errors errors)

Checks if a fields value is within a range (min & max specified in the vars attribute).

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

True if in range, false otherwise.

validateCreditCard

public static Long validateCreditCard(Object bean,
                                      org.apache.commons.validator.ValidatorAction va,
                                      org.apache.commons.validator.Field field,
                                      Errors errors)

Checks if the field is a valid credit card number.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

The credit card as a Long, a null if invalid, blank, or null.

validateEmail

public static boolean validateEmail(Object bean,
                                    org.apache.commons.validator.ValidatorAction va,
                                    org.apache.commons.validator.Field field,
                                    Errors errors)

Checks if a field has a valid e-mail address.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

True if valid, false otherwise.

validateMaxLength

public static boolean validateMaxLength(Object bean,
                                        org.apache.commons.validator.ValidatorAction va,
                                        org.apache.commons.validator.Field field,
                                        Errors errors)

Checks if the field's length is less than or equal to the maximum value. A Null will be considered an error.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

True if stated conditions met.

validateMinLength

public static boolean validateMinLength(Object bean,
                                        org.apache.commons.validator.ValidatorAction va,
                                        org.apache.commons.validator.Field field,
                                        Errors errors)

Checks if the field's length is greater than or equal to the minimum value. A Null will be considered an error.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur. -param request Current request object.

Returns:

True if stated conditions met.

validateValidWhen

public static boolean validateValidWhen(Object bean,
                                        org.apache.commons.validator.ValidatorAction va,
                                        org.apache.commons.validator.Field field,
                                        Errors errors,
                                        org.apache.commons.validator.Validator validator)

Checks if the field matches the boolean expression specified in test parameter.

Parameters:

bean - The bean validation is being performed on.

va - The ValidatorAction that is currently being performed.

field - The Field object associated with the current field being validated.

errors - The Errors object to add errors to if any validation errors occur.

Returns:

true if meets stated requirements, false otherwise.

extractValue

protected static String extractValue(Object bean,
                                     org.apache.commons.validator.Field field)

Extracts the value of the given bean. If the bean is null, the returned value is also null. If the bean is a String then the bean itself is returned. In all other cases, the ValidatorUtils class is used to extract the bean value using the Field object supplied.

See Also:

ValidatorUtils.getValueAsString(Object, String)

rejectValue

public static void rejectValue(Errors errors,
                               org.apache.commons.validator.Field field,
                               org.apache.commons.validator.ValidatorAction va)

Convinience method to perform the work of rejecting a field's value.

Parameters:

errors - the errors

field - the field that was rejected

va - the validator action