Class StringLengthFieldValidator
java.lang.Object
org.apache.struts2.validator.validators.ValidatorSupport
org.apache.struts2.validator.validators.FieldValidatorSupport
org.apache.struts2.validator.validators.StringLengthFieldValidator
- All Implemented Interfaces:
- FieldValidator,- ShortCircuitableValidator,- Validator
 StringLengthFieldValidator checks that a String field is of a certain length.  If the "minLength"
 parameter is specified, it will make sure that the String has at least that many characters.  If
 the "maxLength" parameter is specified, it will make sure that the String has at most that many
 characters.  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
- maxLength - Integer. The max length of the field value. Default ignore.
- minLength - Integer. The min length of the field value. Default ignore.
- trim - (Optional) Boolean, default true. Trim the field value before evaluating its min/max length. Default true.
- maxLengthExpression - (Optional) String. Defines the max length param as an OGNL expression
- minLengthExpression - (Optional) String. Defines the min length param as an OGNL expression
- trimExpression - (Optional) String. Defines th trim param as an OGNL expression
 
 <validators>
     <!-- Plain Validator Syntax -->
     <validator type="stringlength">
         <param name="fieldName">myPurchaseCode</param>
         <param name="minLength">10</param>
         <param name="maxLength">10</param>
         <param name="trim">true</param>
         <message>Your purchase code needs to be 10 characters long</message>
     </validator>
     <!-- Field Validator Syntax -->
     <field name="myPurchaseCode">
         <field-validator type="stringlength">
              <param name="minLength">10</param>
              <param name="maxLength">10</param>
              <param name="trim">true</param>
              <message>Your purchase code needs to be 10 characters long</message>
         </field-validator>
     </field>
     <!-- Field Validator Syntax with expression -->
     <field name="myPurchaseCode">
         <field-validator type="stringlength">
              <param name="minLengthExpression">${minLengthValue}</param> <!-- will be evaluated as: Integer getMinLengthValue() -->
              <param name="maxLengthExpression">${maxLengthValue}</param> <!-- will be evaluated as: Integer getMaxLengthValue() -->
              <param name="trimExpression">${trimValue}</param> <!-- will be evaluated as: boolean getTrimValue() -->
              <message>Your purchase code needs to be 10 characters long</message>
         </field-validator>
     </field>
 </validators>
 
 - Author:
- Jason Carreira, Mark Woon, tmjee
- 
Field SummaryFields inherited from class org.apache.struts2.validator.validators.FieldValidatorSupportcurrentValue, fieldName, typeFields inherited from class org.apache.struts2.validator.validators.ValidatorSupportdefaultMessage, EMPTY_STRING, messageKey, stack, textProviderFactory
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionintintbooleanisTrim()voidsetMaxLength(int maxLength) voidsetMaxLengthExpression(String maxLengthExpression) voidsetMinLength(int minLength) voidsetMinLengthExpression(String minLengthExpression) 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 value) Methods inherited from class org.apache.struts2.validator.validators.FieldValidatorSupportgetCurrentValue, getFieldName, getValidatorType, setFieldName, setValidatorTypeMethods inherited from class org.apache.struts2.validator.validators.ValidatorSupportaddActionError, addFieldError, getDefaultMessage, getFieldValue, getMessage, getMessageKey, getMessageParameters, getValidatorContext, isShortCircuit, parse, setDefaultMessage, setMessageKey, setMessageParameters, setShortCircuit, setTextProviderFactory, setValidatorContext, setValueStackMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.struts2.validator.ValidatorgetDefaultMessage, getMessage, getMessageKey, getMessageParameters, getValidatorContext, setDefaultMessage, setMessageKey, setMessageParameters, setValidatorContext, setValueStack
- 
Constructor Details- 
StringLengthFieldValidatorpublic StringLengthFieldValidator()
 
- 
- 
Method Details- 
setMaxLengthpublic void setMaxLength(int maxLength) 
- 
setMaxLengthExpression
- 
getMaxLengthpublic int getMaxLength()
- 
setMinLengthpublic void setMinLength(int minLength) 
- 
setMinLengthExpression
- 
getMinLengthpublic int getMinLength()
- 
setTrimpublic void setTrim(boolean trim) 
- 
setTrimExpression
- 
isTrimpublic boolean isTrim()
- 
validateDescription 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
 
-