org.apache.commons.validator.routines.RegexValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isoiec7064 Show documentation
A Java library to calculate and validate ISO/IEC 7064 System check digits.
The newest version!
/*
 * 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 org.apache.commons.validator.routines;

import java.io.Serializable;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Regular Expression validation (using the JRE's regular expression support).
 * 
 * Constructs the validator either for a single regular expression or a set (array) of regular expressions. By default validation is case sensitive but
 * constructors are provided to allow case in-sensitive validation. For example to create a validator which does case in-sensitive validation
 * for a set of regular expressions:
 * 
 *
 *  * 
 * String[] regexs = new String[] {...};
 * RegexValidator validator = new RegexValidator(regexs, false);
 * 
 * 
 *
 * 
 * Validate {@code true} or {@code false}:
 * 
 * 
 * {@code boolean valid = validator.isValid(value);}
 * 
 * 
 * Validate returning an aggregated String of the matched groups:
 * 
 * 
 * {@code String result = validator.validate(value);}
 * 
 * 
 * Validate returning the matched groups:
 * 
 * 
 * {@code String[] result = validator.match(value);}
 * 
 * 
 * 
 *
 * Note that patterns are matched against the entire input.
 *
 * 
 * Cached instances pre-compile and re-use {@link Pattern}(s) - which according to the {@link Pattern} API are safe to use in a multi-threaded environment.
 * 
 *
 * @since 1.4
 */
public class RegexValidator implements Serializable {

    private static final long serialVersionUID = -8832409930574867162L;

    private static final int CASE_SENSITIVE = 0;

    private static int toCompileFlags(final boolean caseSensitive) {
        return caseSensitive ? CASE_SENSITIVE : Pattern.CASE_INSENSITIVE;
    }

    /**
     * Compiled RE patterns from constructors.
     */
    private final Pattern[] patterns;

    /**
     * Constructs a new instance that matches any one of the set of regular expressions with the specified case sensitivity.
     *
     * @param regexs The set of regular expressions this validator will validate against
     * @param flags  See {@link Pattern#compile(String, int)}. sensitive, otherwise matching is case in-sensitive
     */
    private RegexValidator(final int flags, final String... regexs) {
        if (regexs == null || regexs.length == 0) {
            throw new IllegalArgumentException("Regular expressions are missing");
        }
        patterns = new Pattern[regexs.length];
        for (int i = 0; i < regexs.length; i++) {
            final String regex = regexs[i];
            if (regex == null || regex.isEmpty()) {
                throw new IllegalArgumentException("Regular expression[" + i + "] is missing");
            }
            patterns[i] = Pattern.compile(regex, flags);
        }
    }

    /**
     * Constructs a new case sensitive instance that matches any one in the list of regular expressions.
     *
     * @param regexs The set of regular expressions this validator will validate against
     */
    RegexValidator(final List regexs) {
        this(CASE_SENSITIVE, regexs.toArray(new String[] {}));
    }

    /**
     * Constructs a new case sensitive instance for a single regular expression.
     *
     * @param regex The regular expression this validator will validate against
     */
    public RegexValidator(final String regex) {
        this(CASE_SENSITIVE, regex);
    }

    /**
     * Constructs a new case sensitive instance that matches any one in the array of regular expressions.
     *
     * @param regexs The set of regular expressions this validator will validate against
     */
    public RegexValidator(final String... regexs) {
        this(CASE_SENSITIVE, regexs);
    }

    /**
     * Constructs a new instance for a single regular expression with the specified case sensitivity.
     *
     * @param regex         The regular expression this validator will validate against
     * @param caseSensitive when {@code true} matching is case sensitive, otherwise matching is case in-sensitive
     */
    public RegexValidator(final String regex, final boolean caseSensitive) {
        this(toCompileFlags(caseSensitive), regex);
    }

    /**
     * Constructs a new instance that matches any one of the set of regular expressions with the specified case sensitivity.
     *
     * @param regexs        The set of regular expressions this validator will validate against
     * @param caseSensitive when {@code true} matching is case sensitive, otherwise matching is case in-sensitive
     */
    public RegexValidator(final String[] regexs, final boolean caseSensitive) {
        this(toCompileFlags(caseSensitive), regexs);
    }

    /**
     * Gets a copy of the Patterns.
     *
     * @return a copy of the Patterns.
     * @since 1.8
     */
    public Pattern[] getPatterns() {
        return patterns.clone();
    }

    /**
     * Validates a value against the set of regular expressions.
     *
     * @param value The value to validate.
     * @return {@code true} if the value is valid otherwise {@code false}.
     */
    public boolean isValid(final String value) {
        if (value == null) {
            return false;
        }
        for (final Pattern pattern : patterns) {
            if (pattern.matcher(value).matches()) {
                return true;
            }
        }
        return false;
    }

    /**
     * Validates a value against the set of regular expressions returning the array of matched groups.
     *
     * @param value The value to validate.
     * @return String array of the groups matched if valid or {@code null} if invalid
     */
    public String[] match(final String value) {
        if (value == null) {
            return null;
        }
        for (final Pattern pattern : patterns) {
            final Matcher matcher = pattern.matcher(value);
            if (matcher.matches()) {
                final int count = matcher.groupCount();
                final String[] groups = new String[count];
                for (int j = 0; j < count; j++) {
                    groups[j] = matcher.group(j + 1);
                }
                return groups;
            }
        }
        return null;
    }

    /**
     * Provides a String representation of this validator.
     *
     * @return A String representation of this validator.
     */
    @Override
    public String toString() {
        final StringBuilder buffer = new StringBuilder();
        buffer.append("RegexValidator{");
        for (int i = 0; i < patterns.length; i++) {
            if (i > 0) {
                buffer.append(",");
            }
            buffer.append(patterns[i].pattern());
        }
        buffer.append("}");
        return buffer.toString();
    }

    /**
     * Validates a value against the set of regular expressions returning a String value of the aggregated groups.
     *
     * @param value The value to validate.
     * @return Aggregated String value comprised of the groups matched if valid or {@code null} if invalid
     */
    public String validate(final String value) {
        if (value == null) {
            return null;
        }
        for (final Pattern pattern : patterns) {
            final Matcher matcher = pattern.matcher(value);
            if (matcher.matches()) {
                final int count = matcher.groupCount();
                if (count == 1) {
                    return matcher.group(1);
                }
                final StringBuilder buffer = new StringBuilder();
                for (int j = 0; j < count; j++) {
                    final String component = matcher.group(j + 1);
                    if (component != null) {
                        buffer.append(component);
                    }
                }
                return buffer.toString();
            }
        }
        return null;
    }

}