com.vaadin.data.validator.RegexpValidator Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* 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;
/**
* 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#sum}
*
*
* See {@link AbstractStringValidator} for more information.
*
*
* An empty string or a null is always accepted - use the required flag on
* fields or a separate validator (or override {@link #isValidValue(String)}) to
* fail on empty values.
*
*
* @author Vaadin Ltd.
* @since 5.4
*/
@SuppressWarnings("serial")
public class RegexpValidator extends AbstractStringValidator {
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 regexp
* a Java regular expression
* @param errorMessage
* the message to display in case the value does not validate.
*/
public RegexpValidator(String regexp, String errorMessage) {
this(regexp, true, errorMessage);
}
/**
* Creates a validator for checking that the regular expression matches the
* string to validate.
*
* @param regexp
* a Java regular expression
* @param complete
* true to use check for a complete match, false to look for a
* matching substring
* @param errorMessage
* the message to display in case the value does not validate.
*/
public RegexpValidator(String regexp, boolean complete,
String errorMessage) {
super(errorMessage);
pattern = Pattern.compile(regexp);
this.complete = complete;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.data.validator.AbstractValidator#isValidValue(java.lang.Object
* )
*/
@Override
protected boolean isValidValue(String value) {
if (value == null || value.isEmpty()) {
return true;
}
if (complete) {
return getMatcher(value).matches();
} else {
return getMatcher(value).find();
}
}
/**
* Get a new or reused matcher for the pattern
*
* @param value
* the string to find matches in
* @return Matcher for the string
*/
private Matcher getMatcher(String value) {
if (matcher == null) {
matcher = pattern.matcher(value);
} else {
matcher.reset(value);
}
return matcher;
}
}