com.vaadin.data.validator.RegexpValidator Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.data.validator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.vaadin.data.ValidationResult;
import com.vaadin.data.ValueContext;
/**
* A string validator comparing the string against a Java regular expression.
* Both complete matches and substring matches are supported.
*
* For the Java regular expression syntax, see {@link java.util.regex.Pattern}.
*
* @author Vaadin Ltd.
* @since 8.0
*/
@SuppressWarnings("serial")
public class RegexpValidator extends AbstractValidator {
private Pattern pattern;
private boolean complete;
private transient Matcher matcher = null;
/**
* Creates a validator for checking that the regular expression matches the
* complete string to validate.
*
* @param errorMessage
* the message to display in case the value does not validate.
* @param regexp
* a Java regular expression
*/
public RegexpValidator(String errorMessage, String regexp) {
this(errorMessage, regexp, true);
}
/**
* Creates a validator for checking that the regular expression matches the
* string to validate.
*
* @param errorMessage
* the message to display in case the value does not validate.
* @param regexp
* a Java regular expression
* @param complete
* true to use check for a complete match, false to look for a
* matching substring
*
*/
public RegexpValidator(String errorMessage, String regexp,
boolean complete) {
super(errorMessage);
pattern = Pattern.compile(regexp);
this.complete = complete;
}
@Override
public ValidationResult apply(String value, ValueContext context) {
return toResult(value, isValid(value));
}
@Override
public String toString() {
return "RegexpValidator[" + pattern + "]";
}
/**
* Returns whether the given string matches the regular expression.
*
* @param value
* the string to match
* @return true if the string matched, false otherwise
*/
protected boolean isValid(String value) {
if (value == null) {
return true;
}
if (complete) {
return getMatcher(value).matches();
} else {
return getMatcher(value).find();
}
}
/**
* Returns a new or reused matcher for the pattern.
*
* @param value
* the string to find matches in
* @return a matcher for the string
*/
private Matcher getMatcher(String value) {
if (matcher == null) {
matcher = pattern.matcher(value);
} else {
matcher.reset(value);
}
return matcher;
}
}