com.opensymphony.xwork2.validator.validators.RequiredStringValidator Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.opensymphony.xwork2.validator.validators;
import com.opensymphony.xwork2.validator.ValidationException;
import java.util.Collection;
/**
*
* 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 {@link String#trim() 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.
*
*
*
*
* Do not use ${trimExpression} as an expression as this will turn into infinitive loop!
*
*
*
*
* <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
*/
public class RequiredStringValidator extends FieldValidatorSupport {
private boolean trim = true;
public void setTrim(boolean trim) {
this.trim = trim;
}
public void setTrimExpression(String trimExpression) {
trim = (Boolean) parse(trimExpression, Boolean.class);
}
public boolean isTrim() {
return trim;
}
public void validate(Object object) throws ValidationException {
Object fieldValue = this.getFieldValue(getFieldName(), object);
if (fieldValue == null) {
addFieldError(getFieldName(), object);
return;
}
if (fieldValue.getClass().isArray()) {
Object[] values = (Object[]) fieldValue;
for (Object value : values) {
validateValue(object, value);
}
} else if (Collection.class.isAssignableFrom(fieldValue.getClass())) {
Collection values = (Collection) fieldValue;
for (Object value : values) {
validateValue(object, value);
}
} else {
validateValue(object, fieldValue);
}
}
protected void validateValue(Object object, Object fieldValue) {
try {
setCurrentValue(fieldValue);
if (fieldValue == null) {
addFieldError(getFieldName(), object);
return;
}
if (fieldValue instanceof String) {
String stingValue = (String) fieldValue;
if (trim) {
stingValue = stingValue.trim();
}
if (stingValue.length() == 0) {
addFieldError(getFieldName(), object);
}
} else {
addFieldError(getFieldName(), object);
}
} finally {
setCurrentValue(null);
}
}
}