software.amazon.awssdk.testutils.hamcrest.Matchers Maven / Gradle / Ivy

Go to download

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

The AWS SDK for Java - Test Utils module holds the all the utilities that are used by the tests.

There is a newer version: 2.29.17

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.testutils.hamcrest;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import org.hamcrest.CoreMatchers;
import org.hamcrest.Matcher;

public final class Matchers {

    private Matchers() {
    }

    /**
     * Creates a matcher that matches if the examined collection matches the specified matchers in order
     *
     * 
     * For example:
     * 
assertThat(Arrays.asList("foo", "bar"), containsOnlyInOrder(startsWith("f"), endsWith("ar")))
     */
    public static  Matcher> containsOnlyInOrder(Matcher... matchers) {
        return CollectionContainsOnlyInOrder.containsOnlyInOrder(Arrays.asList(matchers));
    }

    /***
     * Creates a matcher that matches if the examined collection matches the specified items in order
     *
     * 
     * For example:
     * 
assertThat(Arrays.asList("foo", "bar"), containsOnlyInOrder("foo", "bar"))
     */
    public static  Matcher> containsOnlyInOrder(T... items) {
        return CollectionContainsOnlyInOrder.containsOnlyInOrder(convertToMatchers(Arrays.asList(items)));
    }

    /***
     * Creates a matcher that matches if the examined collection matches the specified items in any order
     *
     * 
     * For example:
     * 
assertThat(Arrays.asList("bar", "foo"), containsOnly(startsWith("f"), endsWith("ar")))
     */
    public static  Matcher> containsOnly(Matcher... matchers) {
        return CollectionContainsOnly.containsOnly(Arrays.asList(matchers));
    }

    /***
     * Creates a matcher that matches if the examined collection matches the specified items in any order
     *
     * 
     * For example:
     * 
assertThat(Arrays.asList("bar", "foo"), containsOnly("foo", "bar"))
     */
    public static  Matcher> containsOnly(T... items) {
        return CollectionContainsOnly.containsOnly(convertToMatchers(Arrays.asList(items)));
    }

    private static  List> convertToMatchers(List items) {
        List> matchers = new ArrayList<>();
        for (T item : items) {
            matchers.add(CoreMatchers.equalTo(item));
        }
        return matchers;
    }

}