com.opensymphony.xwork2.validator.validators
Class RequiredStringValidator

java.lang.Object
  com.opensymphony.xwork2.validator.validators.ValidatorSupport
      com.opensymphony.xwork2.validator.validators.FieldValidatorSupport
          com.opensymphony.xwork2.validator.validators.RequiredStringValidator

All Implemented Interfaces:

FieldValidator, ShortCircuitableValidator, Validator

public class RequiredStringValidator
extends FieldValidatorSupport

RequiredStringValidator checks that a String field is non-null and has a length > 0. (i.e. it isn't ""). The "trim" parameter determines whether it will trim the String before performing the length check. If unspecified, the String will be trimmed.

• fieldName - The field name this validator is validating. Required if using Plain-Validator Syntax otherwise not required
• trim - trim the field name value before validating (default is true)

 
     <validators>
         <!-- Plain-Validator Syntax -->
         <validator type="requiredstring">
             <param name="fieldName">username</param>
             <param name="trim">true</param>
             <message>username is required</message>
         </validator>
         
         <!-- Field-Validator Syntax -->
         <field name="username">
                  <field-validator type="requiredstring">
                 <param name="trim">true</param>
                 <message>username is required</message>
            </field-validator>
         </field>
     </validators>
 
 

Version:

$Date: 2006-07-10 02:30:29 +0200 (Mon, 10 Jul 2006) $ $Id: RequiredStringValidator.java 1063 2006-07-10 00:30:29Z mrdon $

Author:

rainerh

Field Summary

private boolean

doTrim

Fields inherited from class com.opensymphony.xwork2.validator.validators.ValidatorSupport

defaultMessage, log, messageKey

Constructor Summary

RequiredStringValidator()

Method Summary

boolean	getTrim()
void	setTrim(boolean trim)
void	validate(Object object) The validation implementation must guarantee that setValidatorContext will be called with a non-null ValidatorContext before validate is called.

Methods inherited from class com.opensymphony.xwork2.validator.validators.FieldValidatorSupport

getFieldName, getValidatorType, setFieldName, setValidatorType

Methods inherited from class com.opensymphony.xwork2.validator.validators.ValidatorSupport

addActionError, addFieldError, conditionalParse, getDefaultMessage, getFieldValue, getMessage, getMessageKey, getParse, getValidatorContext, isShortCircuit, setDefaultMessage, setMessageKey, setParse, setShortCircuit, setValidatorContext, setValueStack

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.validator.Validator

getDefaultMessage, getMessage, getMessageKey, getValidatorContext, setDefaultMessage, setMessageKey, setValidatorContext, setValueStack

Field Detail

doTrim

private boolean doTrim

Constructor Detail

RequiredStringValidator

public RequiredStringValidator()

Method Detail

setTrim

public void setTrim(boolean trim)

getTrim

public boolean getTrim()

validate

public void validate(Object object)
              throws ValidationException

Description copied from interface: Validator

The validation implementation must guarantee that setValidatorContext will be called with a non-null ValidatorContext before validate is called.

Parameters:

object - the object to be validated.

Throws:

ValidationException - is thrown if there is validation error(s).