org.eclipse.jetty.toolchain.test.ExtraMatchers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jetty-test-helper Show documentation

Unit Testing Support for Jetty (common classes for some unit tests)

There is a newer version: 6.3

//
//  ========================================================================
//  Copyright (c) 1995-2018 Mort Bay Consulting Pty. Ltd.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.toolchain.test;

import java.util.List;

import org.eclipse.jetty.toolchain.test.matchers.IsOrderedCollectionContaining;
import org.eclipse.jetty.toolchain.test.matchers.RegexMatcher;

/**
 * Extra Matchers for the Junit Hamcrest users out there.
 */
public class ExtraMatchers
{
    /**
     * Creates a matcher for {@link Iterable}s that matches when consecutive passes over the
     * examined {@link Iterable} yield at least one item that is matched by the corresponding
     * matcher from the specified itemMatchers. Whilst matching, each traversal of
     * the examined {@link Iterable} will stop as soon as a matching item is found.
     * 
     * For example:
     * 
     * 
     * assertThat(Arrays.asList("foo","bar","baz"),hasItems(endsWith("z"),endsWith("o")))
     * 
     * 
     * @param itemMatchers
     *            the matchers to apply to items provided by the examined {@link Iterable}
     * @param 
     *            the type
     * @return the matcher
     */
    @SuppressWarnings({ "unchecked", "rawtypes" })
    public static  org.hamcrest.Matcher> ordered(List itemMatchers)
    {
        return new IsOrderedCollectionContaining(itemMatchers);
    }

    /**
     * Create a matcher for {@link String} that matches against a regex pattern.
     *
     * 
     *     Returns success based on {@code java.util.regex.Pattern.matcher(input).matches();}
     * 
     *
     * @param pattern the {@link java.util.regex.Pattern} syntax pattern to match against.
     * @return the Regex Matcher
     */
    public static org.hamcrest.Matcher regex(String pattern)
    {
        return new RegexMatcher(pattern);
    }
}