com.vaadin.flow.component.textfield.TextFieldValidationSupport Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.textfield;
import java.io.Serializable;
import java.util.Objects;
import java.util.regex.Pattern;
import com.vaadin.flow.component.HasValue;
import com.vaadin.flow.data.binder.ValidationResult;
/**
* Utility class for performing server-side validation of string values in text
* fields. This is needed because it is possible to circumvent the client side
* validation constraints using browser development tools.
*
* @author Vaadin Ltd
*/
final class TextFieldValidationSupport implements Serializable {
private final HasValue field;
private boolean required;
private Integer minLength;
private Integer maxLength;
private Pattern pattern;
TextFieldValidationSupport(HasValue field) {
this.field = field;
}
/**
* @see GeneratedVaadinTextField#setRequired
*/
void setRequired(boolean required) {
this.required = required;
}
/**
* @see GeneratedVaadinTextField#setMinlength(double)
*/
void setMinLength(Integer minLength) {
this.minLength = minLength;
}
/**
* @see GeneratedVaadinTextField#setMaxlength(double)
*/
void setMaxLength(Integer maxLength) {
this.maxLength = maxLength;
}
/**
* @see GeneratedVaadinTextField#setPattern(String)
*/
void setPattern(String pattern) {
this.pattern = pattern == null || pattern.isEmpty() ? null
: Pattern.compile(pattern);
}
/**
* Test if value is invalid for the field.
*
* @param value
* value to be tested.
* @return true if the value is invalid.
*/
boolean isInvalid(String value) {
ValidationResult requiredValidation = checkRequired(required, value,
field.getEmptyValue());
return requiredValidation.isError() || checkValidity(value).isError();
}
ValidationResult checkValidity(String value) {
final boolean isMaxLengthExceeded = value != null && maxLength != null
&& value.length() > maxLength;
if (isMaxLengthExceeded) {
return ValidationResult.error("");
}
final boolean isMinLengthNotReached = value != null && !value.isEmpty()
&& minLength != null && value.length() < minLength;
if (isMinLengthNotReached) {
return ValidationResult.error("");
}
final boolean valueViolatePattern = value != null && !value.isEmpty()
&& pattern != null && !pattern.matcher(value).matches();
if (valueViolatePattern) {
return ValidationResult.error("");
}
return ValidationResult.ok();
}
public static ValidationResult checkRequired(boolean required, V value,
V emptyValue) {
final boolean isRequiredButEmpty = required
&& Objects.equals(emptyValue, value);
if (isRequiredButEmpty) {
return ValidationResult.error("");
}
return ValidationResult.ok();
}
}