Class RequiredStringValidator
java.lang.Object
org.apache.struts2.validator.validators.ValidatorSupport
org.apache.struts2.validator.validators.FieldValidatorSupport
org.apache.struts2.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 - (Optional) Boolean, default true. Trims the field name value before validating.
- trimExpression - (Optional) String. Specifies the trim param as an OGNL expression.
<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>
<!-- Field-Validator Syntax with expression -->
<field name="username">
<field-validator type="requiredstring">
<param name="trimExpression">${trimValue}</param> <!-- will be evaluated as: boolean getTrimValue() -->
<message>username is required</message>
</field-validator>
</field>
</validators>
- Author:
- rainerh
-
Field Summary
Fields inherited from class org.apache.struts2.validator.validators.FieldValidatorSupport
currentValue, fieldName, typeFields inherited from class org.apache.struts2.validator.validators.ValidatorSupport
defaultMessage, EMPTY_STRING, messageKey, stack, textProviderFactory -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanisTrim()voidsetTrim(boolean trim) voidsetTrimExpression(String trimExpression) voidThe validation implementation must guarantee that setValidatorContext will be called with a non-null ValidatorContext before validate is called.protected voidvalidateValue(Object object, Object fieldValue) Methods inherited from class org.apache.struts2.validator.validators.FieldValidatorSupport
getCurrentValue, getFieldName, getValidatorType, setFieldName, setValidatorTypeMethods inherited from class org.apache.struts2.validator.validators.ValidatorSupport
addActionError, addFieldError, getDefaultMessage, getFieldValue, getMessage, getMessageKey, getMessageParameters, getValidatorContext, isShortCircuit, parse, setDefaultMessage, setMessageKey, setMessageParameters, setShortCircuit, setTextProviderFactory, setValidatorContext, setValueStackMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.struts2.validator.Validator
getDefaultMessage, getMessage, getMessageKey, getMessageParameters, getValidatorContext, setDefaultMessage, setMessageKey, setMessageParameters, setValidatorContext, setValueStack
-
Constructor Details
-
RequiredStringValidator
public RequiredStringValidator()
-
-
Method Details
-
setTrim
public void setTrim(boolean trim) -
setTrimExpression
-
isTrim
public boolean isTrim() -
validate
Description copied from interface:ValidatorThe 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).
-
validateValue
-