com.opensymphony.xwork2.validator.validators: public class: RequiredStringValidator

com.opensymphony.xwork2.validator.validators
public class: RequiredStringValidator [javadoc | source]

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

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>

author: rainerh -

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

Fields inherited from com.opensymphony.xwork2.validator.validators.ValidatorSupport:
log, defaultMessage, messageKey

Method from com.opensymphony.xwork2.validator.validators.RequiredStringValidator Summary:
getTrim, setTrim, validate

Methods from com.opensymphony.xwork2.validator.validators.FieldValidatorSupport:
getFieldName, getValidatorType, setFieldName, setValidatorType

Methods from com.opensymphony.xwork2.validator.validators.ValidatorSupport:
addActionError, addFieldError, conditionalParse, getDefaultMessage, getFieldValue, getMessage, getMessageKey, getParse, getValidatorContext, getValidatorType, isShortCircuit, setDefaultMessage, setMessageKey, setParse, setShortCircuit, setValidatorContext, setValidatorType, setValueStack

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.opensymphony.xwork2.validator.validators.RequiredStringValidator Detail:
public boolean getTrim() { return doTrim; }
public void setTrim(boolean trim) { doTrim = trim; }
public void validate(Object object) throws ValidationException { String fieldName = getFieldName(); Object value = this.getFieldValue(fieldName, object); if (!(value instanceof String)) { addFieldError(fieldName, object); } else { String s = (String) value; if (doTrim) { s = s.trim(); } if (s.length() == 0) { addFieldError(fieldName, object); } } }

Method from com.opensymphony.xwork2.validator.validators.RequiredStringValidator Detail:

 public boolean getTrim() {
        return doTrim;
}

 public  void setTrim(boolean trim) {
        
        doTrim = trim;
}

 public  void validate(Object object) throws ValidationException {
        String fieldName = getFieldName();
        Object value = this.getFieldValue(fieldName, object);
        if (!(value instanceof String)) {
            addFieldError(fieldName, object);
        } else {
            String s = (String) value;
            if (doTrim) {
                s = s.trim();
            }
            if (s.length() == 0) {
                addFieldError(fieldName, object);
            }
        }
}