org.llorllale.cactoos.matchers.HasValues Maven / Gradle / Ivy

Go to download
/*
 * The MIT License (MIT)
 *
 * Copyright (c) for portions of project cactoos-matchers are held by
 * Yegor Bugayenko, 2017-2018, as part of project cactoos.
 * All other copyright for project cactoos-matchers are held by
 * George Aristy, 2018-2020.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.llorllale.cactoos.matchers;

import org.cactoos.iterable.IterableOf;
import org.cactoos.list.ListOf;
import org.cactoos.text.TextOf;

/**
 * Matcher to check that {@link Iterable} has particular elements.
 *
 * Here is an example how {@link HasValues} can be used:
 * {@code
 *  new Assertion<>(
 *     "must match",
 *     new ListOf<>(1, 2, 3),
 *     new HasValues<>(2)
 *  ).affirm();
 * }
 *
 * @param  Type of item.
 * @since 1.0.0
 */
public final class HasValues extends MatcherEnvelope> {
    /**
     * Ctor.
     * @param expected The expected values within unit test.
     */
    @SafeVarargs
    public HasValues(final X... expected) {
        this(new IterableOf<>(expected));
    }

    /**
     * Ctor.
     * @param expected The expected values within unit test.
     */
    public HasValues(final Iterable expected) {
        super(
            new MatcherOf<>(
                actual -> new ListOf<>(actual).containsAll(new ListOf<>(expected)),
                desc -> desc.appendText("contains ")
                    .appendValue(new TextOf(expected)),
                (actual, desc) -> desc.appendValue(new TextOf(actual))
            )
        );
    }
}