StringMatchers.java

// Copyright 2015 The Project Buendia Authors
//
// Licensed 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 distrib-
// uted 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
// specific language governing permissions and limitations under the License.

package org.projectbuendia.client.ui.matchers;

import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

import java.util.regex.Pattern;

/** Matchers for matching {@link String} objects. */
public class StringMatchers {
    /**
     * Provides a {@link Matcher} that matches any String that matches the given regular expression.
     * @param regex the regular expression pattern to match
     */
    public static Matcher<String> matchesRegex(final String regex) {
        return new TypeSafeMatcher<String>() {
            @Override public void describeTo(Description description) {
                description.appendText("matches regex: " + regex);
            }

            @Override public boolean matchesSafely(String specimen) {
                return Pattern.matches(regex, specimen);
            }
        };
    }
}