org.llorllale.cactoos.matchers.ScalarHasValue 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.
 *
 * 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.Scalar;
import org.cactoos.scalar.UncheckedScalar;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;
import org.hamcrest.core.IsEqual;

/**
 * Matcher for the value.
 *
 * @param  Type of result
 * @since 0.2
 */
public final class ScalarHasValue extends TypeSafeMatcher> {

    /**
     * Matcher of the value.
     */
    private final Matcher matcher;

    /**
     * Ctor.
     * @param text The text to match against
     */
    public ScalarHasValue(final T text) {
        this(new IsEqual<>(text));
    }

    /**
     * Ctor.
     * @param mtr Matcher of the text
     */
    public ScalarHasValue(final Matcher mtr) {
        super();
        this.matcher = mtr;
    }

    @Override
    public void describeTo(final Description description) {
        description.appendText("Scalar with ");
        description.appendDescriptionOf(this.matcher);
    }

    // @checkstyle ProtectedMethodInFinalClassCheck (1 line)
    @Override
    protected boolean matchesSafely(final Scalar item) {
        return this.matcher.matches(
            new UncheckedScalar<>(item).value()
        );
    }

    // @checkstyle ProtectedMethodInFinalClassCheck (1 line)
    @Override
    protected void describeMismatchSafely(final Scalar item,
        final Description description) {
        description
            .appendText("was ")
            .appendValue(
                new UncheckedScalar<>(item).value()
            );
    }
}